doc: hook up sphinx #185
doc: hook up sphinx #185
Conversation
whot
force-pushed
the
wip/sphinx
branch
2 times, most recently
from
0507684
to
25b9538
Compare
doc/conf.py
Outdated
| project = 'python-dbusmock' | ||
| copyright = '2023, Martin Pitt' # noqa: A001 | ||
| author = 'Martin Pitt' | ||
| release = '0.29.1' |
There was a problem hiding this comment.
This needs to use the dynamic version like here.
There was a problem hiding this comment.
Hmm, does this even appear anywhere? I don't see it on https://whot.github.io/python-dbusmock/index.html or https://whot.github.io/python-dbusmock/autoapi/dbusmock/index.html or https://whot.github.io/python-dbusmock/search.html?q=0.29.1
There was a problem hiding this comment.
I had to grep the source code and yes, it does show up:
<title>python-dbusmock — python-dbusmock 0.29.1 documentation</title>
Guess with everyone having a thousand tabs open no-one would notice that ;)
There was a problem hiding this comment.
Locally the dynamic import works in the sense of sphinx-build succeeding. I pushed that.
I also added the two new directories to .gitignore.
martinpitt
force-pushed
the
wip/sphinx
branch
from
325189b
to
c4d8fbd
Compare
|
Et voilà: https://martinpitt.github.io/python-dbusmock/ 🚀 |
|
it's like the future! :) |
For reference, this is how it looks like: https://whot.github.io/python-dbusmock/
Needs enabling in https://github.com/martinpitt/python-dbusmock/settings/pages, change to
Source: Github Action.This is the minimal conversion only, using the readme as index page and with a few rst-ifications in the
DBusMockObjectclass (but not inDBusTestCasebecause that would conflict with #184). Once it's in place we can prettify all this one-by-one.A helperMakefileis included too to build it locally.