django-sphinx-view
django-sphinx-view copied to clipboard
carltongibson
Django Powered Dynamic Sphinx Docs.
The initial `rsync` approach is fine, but... * It depends on a `node` job to set up the SSH credentials. * Much better to create an artefact and then **notify**...
Docs get rearranged. Links get broken. Highlighting potential matches by path segment and/or search can help send folks on the right way. You want that within a docs set though,...
- [ ] Licence file and trove classifier - [ ] Other classifiers - [ ] `requires` and `python_requires`. - [ ] ...
Follow-up to #12/#15 — adding global TOC. By setting [file-wide metadata](https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#file-wide-metadata), before any other markup: ``` :page_template: sphinx_view/no-globaltoc.html ``` … it's possibly to switch the template used to render each...
If `json_build_dir` doesn't exist you get a 404, which is _OK_, I guess, but it doesn't distinguish between, an expected, _This page/URL doesn't exist_, and, the misconfigured, _The path you've...
Once settled: - [ ] Restrict auto-deploy to tags. - [ ] Document that folks should build the version they want otherwise.