Sphinx-based documentation #17
Conversation
Codecov Report
@@ Coverage Diff @@
## main #17 +/- ##
=======================================
Coverage 74.17% 74.17%
=======================================
Files 3 3
Lines 333 333
Branches 71 71
=======================================
Hits 247 247
Misses 68 68
Partials 18 18
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
docs/conf.py
Outdated
| @@ -0,0 +1,53 @@ | |||
| # Configuration file for the Sphinx documentation builder. | |||
There was a problem hiding this comment.
Remove all the unnecessary comments as in https://github.com/pypa/virtualenv/blob/main/docs/conf.py#L1-L89
docs/conf.py
Outdated
| author = "The platformdirs team" | ||
|
|
||
| # The full version, including alpha/beta/rc tags | ||
| release = "2.0.0" |
There was a problem hiding this comment.
This should be imported from the package not declared again.
There was a problem hiding this comment.
Oh and yes, definitely add it to the CI.
There was a problem hiding this comment.
I'm not familiar enough with Microsoft's CI system to figure out how the setup works and where to add it. Do you mind addressing that separately?
This includes documentation following the standard Python style. Sphinx can be used to build this into HTML, and it should be trivial to hook this up to something like RTD to publish them too. Locally, `tox -e docs` can be used to builds docs. It may make sense to include this in CI too to make sure docs continue to build.
Including rendering codeblocks properly.
Signed-off-by: Bernát Gábor <[email protected]>
Signed-off-by: Bernát Gábor <[email protected]>
|
Looking good.
A link back to the repository is missing.
Looks like GitHub stripped all the details from commit messages and cover letter in the resulting merge commit :(
|
|
Yeah, that was on purpose, I personally always squash merge PR s 🤔 |
This includes documentation following the standard Python style. Sphinx
can be used to build this into HTML, and it should be trivial to hook
this up to something like RTD to publish them too.
Locally,
tox -e docscan be used to builds docs. It may make sense toinclude this in CI too to make sure docs continue to build.
I'd suggest building the docs to review this, rather than trying to read the
inline-docs themselves (though these are still perfectly readable).