-
Notifications
You must be signed in to change notification settings - Fork 21
Build documentation with mkdocs
#38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Build documentation with mkdocs
#38
Conversation
This is just a first step to including the correct items in the api docs
peytondmurray
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few changes mentioned below, but also:
Can we have a workflow that also builds (but doesn't deploy) the docs trigger when a PR is made? With the way it currently is currently building on push to master, contributors can easily break documentation without knowing it.
.github/workflows/cd-docs.yml
Outdated
| mkdocs-material- | ||
|
|
||
| - name: Install Dependencies | ||
| run: pip install mkdocs mkdocs-material mkdocstrings[python] griffe-inherited-docstrings mkdocs-autorefs mkdocs-jupyter mkdocs-caption markdown-grid-tables |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can these be moved into a dedicated optional dependency? pip install '.[docs]' or similar so that the dependencies can actually be tracked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Made this change, mirroring what we've done for the other repos we're working on. |
|
Hi @hassler-google, is there anything else I can do to help push this forward? It would be great to get this merged. |
peytondmurray
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, this one was a lot of work. Thanks for this!
One request: can the docs_dir be the default docs/? Or is there some reason to have them be under g3doc?
00ed1d7 to
85345a6
Compare
@peytondmurray Done |
This PR builds the documentation using
mkdocs.The following is included in this PR:
mkdocs.ymlconfiguration along with associated javascript and stylesheetsmkdocstrings__all__list in appropriate__init__.pyfilesREADME.mdas homepage by creating a softlink to it from the documentation folderIn order to deploy the documentation, a maintainer will need to enable publishing from a branch on this repo for the
gh-pagesbranch after this PR is merged.Here is a preview of the new documentation