|
1 년 전 | |
---|---|---|
.. | ||
source | 1 년 전 | |
Makefile | 2 년 전 | |
README.md | 2 년 전 |
datalad-gooey
uses Sphinx for document generation
and suggests using Read the Docs for automatic documentation building, versioning, and hosting.
Once you are ready to document your extension software, take note of the following:
Edit your docs/source/index.rst
file using reStructuredText,
which is the default plaintext markup language used by Sphinx. Add further documentation as needed.
For testing locally whether your documentation builds and renders correctly, first install the developer requirements from the repository's root directory:
pip install -r requirements-devel.txt
Then build the documentation locally:
make -C docs html
Navigate to docs/build/
and open index.html
in your browser to view your documentation.
The GitHub Action workflow located at .github/workflows/docbuild.yml
will run on a push or pull request to your GitHub repository's master/main branch. This builds the documentation remotely and serves as an automated documentation test.