Closed Devasy23 closed 2 months ago
This Pull Request adds Sphinx to the project and includes comprehensive documentation for all folders in the repository.
docs
conf.py
.rst
.md
index.rst
make html
_build/html
recommonmark
myst-parser
Overview
This Pull Request adds Sphinx to the project and includes comprehensive documentation for all folders in the repository.
Changes
docs
directory to hold Sphinx configuration and documentation files.conf.py
for Sphinx configuration..rst
) and/or Markdown (.md
) files.index.rst
to include a table of contents linking to the documentation of each folder.How to Test
docs
directory.make html
to generate the HTML documentation._build/html
).Additional Notes
recommonmark
ormyst-parser
is installed if using Markdown files.Checklist
index.rst
updated with links to all documented sections.