Skip to content
This repository has been archived by the owner on Aug 18, 2023. It is now read-only.

Add sphinx and Read the Docs #240

Merged
merged 51 commits into from
Apr 28, 2022
Merged

Add sphinx and Read the Docs #240

merged 51 commits into from
Apr 28, 2022

Conversation

zaqqwerty
Copy link
Contributor

@zaqqwerty zaqqwerty commented Apr 27, 2022

Resolves #27

Adds infrastructure for using Sphinx to generate documentation from code. Initial index.rst and reference.rst added to generate the docs. .readthedocs.yaml tweaks the default Read the Docs build to read from our Poetry compatible pyproject.toml

This build can be viewed at https://qhbm-library--240.org.readthedocs.build/en/240/. Currently LaTeX in docstrings does not render, see #242

@zaqqwerty zaqqwerty requested a review from farice April 28, 2022 00:35
Copy link
Contributor

@farice farice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing that would be great is to get the tex to render in the docs via mathjax

Not sure if this helps: https://www.sphinx-doc.org/en/master/usage/extensions/math.html

@farice
Copy link
Contributor

farice commented Apr 28, 2022

Sorry just saw the last line of the desc - do we want to add this extension integration now or defer to another PR?

@zaqqwerty
Copy link
Contributor Author

Not sure what it will take to enable, so I'm thinking getting a first draft of docs up first would be good.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation
2 participants