Add docs session to noxfile #202
Conversation
googlebot
added
the
cla: yes
|
To merge after googleapis/gapic-generator#2619 |
|
|
||
| @nox.session(python="3.7") | ||
| def docs(session): | ||
| """Build the docs.""" |
There was a problem hiding this comment.
this builds the docs for python libraries specifically? so would this be run as part of the nightly synthtool run on google-cloud-python as an example?
might be worth fleshing out the comment slightly more to call this out: "generates docs for python libraries nightly"?
will generating docs for other languages require the similar addition of a noxfile?
There was a problem hiding this comment.
These templates only get used for the Python monorepo, google-cloud-python. Docs currently get built all together at the top level.
With this addition to the noxfile, you can go to a specific subdirectory like google-cloud-python/tasks, run nox -s docs and generate documentation for just that package. This is needed for googleapis.dev, which wants docsets by package. It's also faster than building all of the docs.
This won't run in any nightly/release builds right now, but it will be in release builds once Python is ready to move to googleapis.dev
There was a problem hiding this comment.
👍 awesome, thanks for clarifying.
No description provided.