Touch up documentation

This commit is contained in:
RunasSudo 2022-11-10 18:28:46 +11:00
parent ed67a4a610
commit b40f63aa43
Signed by: RunasSudo
GPG Key ID: 7234E476BF21C61A
3 changed files with 20 additions and 1 deletions

View File

@ -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 <https://yingtongli.me/scipy-yli-docs/>.
Examples can be found in the unit tests in the *tests* directory.
## Warning

14
docs/_static/override.css vendored Normal file
View File

@ -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;
}

View File

@ -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']