From b40f63aa4319cbf5bed7889a7f29c3e86e907e47 Mon Sep 17 00:00:00 2001 From: RunasSudo Date: Thu, 10 Nov 2022 18:28:46 +1100 Subject: [PATCH] Touch up documentation --- README.md | 6 +++++- docs/_static/override.css | 14 ++++++++++++++ docs/conf.py | 1 + 3 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 docs/_static/override.css diff --git a/README.md b/README.md index 2ea7597..7264288 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,11 @@ Relevant statistical functions are all directly available from the top-level *yl * Bayesian inference: * *bayesfactor_afbf*: Adjusted fractional Bayes factor for a hypothesis on parameters from regression -Each function is documented in the respective docstring within the source code, and Sphinx documentation is buildable from the *docs* directory. Examples can be found in the unit tests in the *tests* directory. +## Documentation and examples + +Each function is documented in the respective docstring within the source code, and Sphinx documentation is buildable from the *docs* directory. Hosted documentation is available at . + +Examples can be found in the unit tests in the *tests* directory. ## Warning diff --git a/docs/_static/override.css b/docs/_static/override.css new file mode 100644 index 0000000..6fc1ac0 --- /dev/null +++ b/docs/_static/override.css @@ -0,0 +1,14 @@ +/* https://github.com/readthedocs/sphinx_rtd_theme/issues/1322 */ +dl.field-list > dt:after { + display: none; +} + +/* Fix empty paragraph at start of field list text */ +.field-list dd p:empty:first-child { + display: none; +} + +/* Add some space */ +html.writer-html5 .rst-content dl.field-list > dd, html.writer-html5 .rst-content dl.field-list > dt { + margin-bottom: 12px; +} diff --git a/docs/conf.py b/docs/conf.py index 8c900b7..1e25242 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,3 +28,4 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] html_theme = 'sphinx_rtd_theme' html_static_path = ['_static'] +html_css_files = ['override.css']