From 2e9e0d9ab2e0e76f5586b2351261dadbf990b379 Mon Sep 17 00:00:00 2001 From: Christian Hagau Date: Thu, 6 Jun 2024 14:14:44 +0200 Subject: [PATCH] docs: add a comment on the numpydoc docstring format style used when documenting the code --- docs/source/documentation.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/documentation.md b/docs/source/documentation.md index 20ce6da..444d2c0 100644 --- a/docs/source/documentation.md +++ b/docs/source/documentation.md @@ -1,13 +1,19 @@ # Documentation -This project is documented using +This project documentation is generated using [Sphinx](https://www.sphinx-doc.org) and [numpydoc](https://numpydoc.readthedocs.io). +The numpydoc formatting style as documented in the + [style guide](https://numpydoc.readthedocs.io/en/latest/format.html) +is used. See the + [example](https://numpydoc.readthedocs.io/en/latest/example.html#example) in +the numpydoc documentation on how to properly document the code. + The theme being used is [Read the Docs Sphinx Theme](https://sphinx-rtd-theme.readthedocs.io). To generate the documentation (in HTML format, see `doc/Makefile` for other formats), execute: ``` cd docs make html -``` \ No newline at end of file +```