-
Notifications
You must be signed in to change notification settings - Fork 83
Closed
Labels
devopsDevOps relatedDevOps relateddocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
A few things are clunky:
- We have a separate
./docs/Makefile
which gives youmake html
andmake clean
commands. It's not a massive deal but it means you have tocd
intodocs
first and I often forget to do that, or to move back into the project root afterwards. We should remove./docs/Makefile
and get theMakefile
in the project root to do all the work. - That
./docs/Makefile
is pretty cryptic. I think I originally got it from some external documentation, so I don't really understand how it works. We can maybe use the pymc-marketingMakefile
as inspiration. But it has clear commandshtml
andcleandocs
, which is nice. - The current way we clean the docs
cd docs; make clean
removes everything from./docs/build
, which is fine. However I am finding in practice you also need to manually remove the contents of./docs/source/api/generated/
, otherwise you can run into errors when building the docs locally. - We'd also want to update the few relevant parts in
CONTRIBUTING.md
Metadata
Metadata
Assignees
Labels
devopsDevOps relatedDevOps relateddocumentationImprovements or additions to documentationImprovements or additions to documentation