DM-46368: Add support for building an LTD documentation site #38
Conversation
JeremyMcCormick
force-pushed
the
tickets/DM-46368
branch
6 times, most recently
from
814fe78 to
97c0df6
Compare
| "on": | ||
| merge_group: {} | ||
| pull_request: {} | ||
| push: |
There was a problem hiding this comment.
On the DM side we usually do branches: main rather than try to exclude, but this is fine.
There was a problem hiding this comment.
This was copied from a SQuaRE template. I have no preference, and this can be changed if you like. The rules defined here are just an optimization so workflows aren't run more than once unnecessarily.
| isolated_build = True | ||
|
|
||
| [testenv] | ||
| description = Run pytest against {envname}. |
There was a problem hiding this comment.
I'm a little worried that the testing here is going to conflict with how we want/need to do testing in per-component subdirectories. Can we leave this out for a docs-only commit?
There was a problem hiding this comment.
Unless you plan to use tox for running tests, then this file should not affect anything else. Pytest won't look at this file if you run it directly.
I would suggest we leave this in as it is basically working boilerplate that I copied from another project so that tox -e docs works, as well as the tox github action. It can certainly be altered later if it creates conflicts.
This adds tox configuration, documenteer configuration, a few updates to other config files, and markdown to generate an example (blank) user guide website for ConsDB.
JeremyMcCormick
force-pushed
the
tickets/DM-46368
branch
from
5b5aa1d to
9379416
Compare
This is a basic configuration plus a few markdown files for building an LTD documentation site with Tox and Sphinx.
No support was added for API documentation for the moment, because the external dependencies listed in
pyproject.yamlare incomplete. So Sphinx cannot load the Python modules.Todo