Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 748 Bytes

README.md

File metadata and controls

18 lines (12 loc) · 748 Bytes

Readthedocs Sphinx Files

These are the files for Readthedocs to use for generating documentation pages based on Sphinx. This was setup by running the commands:

sphinx-quickstart
sphinx-apidoc -o . ../randomdataset

The generated conf.py file was modified to add the current and parent directories to sys.path, add 'sphinx.ext.autodoc' to the list of used extensions, and changing the html theme.

Readthedocs additionally depends on the .readthedocs.yaml file in the project root.

The dependencies for the library itself were added to requirements.txt here since there isn't a requirements.txt in the root anymore, only the pyproject.toml file is present but Sphinx/readthedocs doesn't use this.