-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
22 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,33 @@ | ||
# Compiling gninatorch's Documentation | ||
# Compiling spyrmsd's Documentation | ||
|
||
The docs for this project are built with [Sphinx](http://www.sphinx-doc.org/en/master/). | ||
To compile the docs, first ensure that Sphinx and the ReadTheDocs theme are installed. | ||
|
||
## Installation | ||
|
||
Ensure that Sphinx and the ReadTheDocs theme are installed: | ||
|
||
```bash | ||
conda install sphinx sphinx_rtd_theme | ||
``` | ||
|
||
## Documentation | ||
|
||
### Automatic API Documentation | ||
|
||
Create API documentation automatically with `sphinx-apidoc`: | ||
|
||
Once installed, you can use the `Makefile` in this directory to compile static HTML pages by | ||
```bash | ||
make html | ||
sphinx-apidoc -f -M -e -T -o source/api ../gninatorch | ||
``` | ||
|
||
The compiled docs will be in the `_build` directory and can be viewed by opening `index.html` (which may itself | ||
be inside a directory called `html/` depending on what version of Sphinx is installed). | ||
### Build Documentation | ||
|
||
Use the `Makefile` to compile static HTML pages: | ||
|
||
```bash | ||
make html | ||
``` | ||
|
||
A configuration file for [Read The Docs](https://readthedocs.org/) (readthedocs.yaml) is included in the top level of the repository. To use Read the Docs to host your documentation, go to https://readthedocs.org/ and connect this repository. You may need to change your default branch to `main` under Advanced Settings for the project. | ||
### Visualize Documentation | ||
|
||
If you would like to use Read The Docs with `autodoc` (included automatically) and your package has dependencies, you will need to include those dependencies in your documentation yaml file (`docs/requirements.yaml`). | ||
The compiled docs will be in the `build` directory and can be viewed by opening `index.html` (which may itself be inside a directory called `html/` depending on what version of Sphinx is installed). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters