Add Sphinx documentation site #2
Conversation
| @@ -0,0 +1,142 @@ | |||
| #!/usr/bin/env python3 | |||
There was a problem hiding this comment.
This file is mostly generated directly from Sphinx project generator.
|
Just a note that anywhere else, we are AFAIK consistently using RTD theme. Any reason for preference for Alabaster? |
@Almad It's the default theme for Sphinx so that's the biggest reason, I just simply did not change it. I do think Alabaster looks cleaner however, and Alabaster uses a font which is a bit more readable. I've used this on pretty much every Sphinx site I've created (https://swiftenv.fuller.li/en/latest/, https://stencil.fuller.li/en/latest/, https://curassow.fuller.li/en/latest/). The other theme is also left aligned and doesn't work well on all display sizes:
However, I can change this for consistency with Dredd documentation. |
|
@kylef I think we should go with consistency. Open to which theme we should use—probably something for brainstorm and/or team lead sync. Also //cc @michalholasek @w-vi @abtris |
This PR adds the base Sphinx documentation with installation and basic usage. This is an MVP. I have full API reference and documentation to publish, I will incrementally PR the separate changes.