Skip to content

Commit bf5e4c1

Browse files
committed
docs: additional notes for contributions
1 parent 5d31f90 commit bf5e4c1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/sources/contributing.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,13 @@ The `Makefile <Makefile>`_ defines three main targets: ``lint`` for Ruff linting
7171
7272
Linting warnings should be addressed first. The doctests serve as acceptance tests, and should be run first, before the unit tests.
7373

74+
.. _contributing.documentation
75+
76+
Documentation
77+
=============
78+
79+
`Project documentation <https://continuedfractions.readthedocs.io/en/latest/>`_ is defined and built using `Sphinx <https://www.sphinx-doc.org/en/master/>`_, and deployed to `Read The Docs <https://readthedocs.org>`_. Currently, the building and deployment steps for documentation are not automated in a CI pipeline, but are done manually - this will be addressed in future releases.
80+
7481
.. _contributing.ci-cd:
7582

7683
Continuous Integration and Deployment (CI/CD)

0 commit comments

Comments
 (0)