Add Sphinx configuration. #16
Conversation
|
Fixes Mbed-TLS/mbedtls#3643 |
Generated with Sphinx 4.1.2 quickstart utility. Options: > Separate source and build directories (y/n) [n]: > Project name: Mbed TLS > Author name(s): The Mbed TLS Contributors > Project release []: > Project language [en]: Signed-off-by: David Horstmann <david.horstmann@arm.com>
Signed-off-by: David Horstmann <david.horstmann@arm.com>
Add the MyST parser extension so that Sphinx can take Markdown as input. This can be acquired here: https://github.com/executablebooks/MyST-Parser Signed-off-by: David Horstmann <david.horstmann@arm.com>
Add README.md and CONTRIBUTING.md to ignore list so they aren't parsed as documentation. Signed-off-by: David Horstmann <david.horstmann@arm.com>
Signed-off-by: David Horstmann <david.horstmann@arm.com>
davidhorstmann-arm
force-pushed
the
migrate-sphinx
branch
from
1f750b8 to
9887714
Compare
gilles-peskine-arm
left a comment
gilles-peskine-arm
left a comment
There was a problem hiding this comment.
The history looks good now, thanks. The finished version needs a little polishing to be publishable.
| ==================================== | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 |
There was a problem hiding this comment.
(likely non-actionable for now) A depth of 2 looks about right but I don't think the current structure works. The home page shouldn't have direct links to sections of each subpage. But the subpages should be grouped by topic: review guidelines under contributing, security advisories under news or security, long-term plans and maintainers under project, ...
But it's a bit hard to anticipate the right structure when we have so little content. We can go with what we have for now and restructure it as we go.
| @@ -0,0 +1,52 @@ | |||
| # Configuration file for the Sphinx documentation builder. | |||
There was a problem hiding this comment.
(likely non-actionable for now) The build comes up with many warnings. They're cosmetic so no big deal. Eventually I think we should enforce a build without warnings but it's too early for that.
Add the sphinx Makefile so that the docs can be built with the command `make html`. Signed-off-by: David Horstmann <david.horstmann@arm.com>
Signed-off-by: David Horstmann <david.horstmann@arm.com>
Add a basic description of the docs to index.rst along with links to other sources of information. Signed-off-by: David Horstmann <david.horstmann@arm.com>
Note: Required a change of title for disambiguation. Signed-off-by: David Horstmann <david.horstmann@arm.com>
2 participants
This adds the
conf.pyandindex.rstfiles required by sphinx to build the documentation.Signed-off-by: David Horstmann david.horstmann@arm.com