This repository has been archived by the owner on Jun 4, 2022. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR creates an initial set of documentation using Sphinx and Restructured Text, based on a pattern I've used for Lacinia and Lacinia-Pedestal. It's very easy to get things set up on ReadTheDocs.org.
There's not a lot here ... think of this as a skeleton and head start. I also hit the limits of my knowledge with Lumo in a few places and I need to switch back to other work now.
Do set this up locally, you'll need to install Python, pip (the Python package manager) and then:
You can edit documentation by going into the
docs
folder and executemake live
. This will open up a browser. The browser live reloads when files change. The default RTD theme looks fine to me, and the built-in navigation (and search) is super-useful.Get in contact if you need any extra help. I may have more time to work on documentation next week.