Generate documentation #120
Conversation
There was a problem hiding this comment.
This could be replaced by a readthedocs.yml file at the root of the repository to publish the docs with readthedocs: https://pydoctor.readthedocs.io/en/latest/publish-readthedocs.html
There was a problem hiding this comment.
yeah, I'm more familiar with read the doc, plus I'd rather have the doc linked to the project name and not my github handle
There was a problem hiding this comment.
Sounds good I’ll do that.
There was a problem hiding this comment.
@serge-sans-paille I've added the .readthedocs.yalm file. Tell me when you finalize the integration with ReadThedocs. Don't forget to enable to builds on Pull requests. Then I'll add a commit to the branch and we'll see if it works.
| @@ -1,3 +1,8 @@ | |||
| from __future__ import absolute_import | |||
There was a problem hiding this comment.
I removed this legacy import as a drive-by change
| UseDefChains, | ||
| Def, ) | ||
|
|
||
| __all__ = ['Ancestors', 'DefUseChains', 'UseDefChains', 'Def', '__version__'] |
There was a problem hiding this comment.
This is necessary such that public objects are documented in the top-level module and not where they are implemented
| @@ -1,3 +1,8 @@ | |||
| from __future__ import absolute_import | |||
| ".. include:: README.rst" | |||
There was a problem hiding this comment.
The content of the readme will be duplicated on the generated website. Maybe it's best to keep it simple and write a couple of lines instead?
| PRIVATE:beniget.beniget | ||
| PRIVATE:beniget.ordered_set | ||
| PRIVATE:beniget.version |
There was a problem hiding this comment.
This hides all submodules by default, but they can be shown by clicking on "Show Private" button at the top of each page.
| commands=pytest --doctest-modules {posargs:beniget/ tests/} | ||
| [testenv:docs] |
There was a problem hiding this comment.
This tox environment is only used for local development.
.github/workflows/docs.yml
Outdated
| --project-url=https://github.com/$GITHUB_REPOSITORY \ | ||
| --html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \ | ||
| --html-base-url=https://$GITHUB_REPOSITORY_OWNER.github.io/${GITHUB_REPOSITORY#*/} \ |
There was a problem hiding this comment.
Other non-dynamic options are given by the config file.
It looks like this: https://tristanlatr.github.io/beniget/