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
2 changed files
with
12 additions
and
0 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,5 +1,13 @@ | ||
# readthedocs | ||
This repository contains the top-level documentation for NJOY21. It is best viewed at [docs.njoy21.io](https://docs.njoy21.io). | ||
|
||
## Building | ||
This documentation uses [Sphinx](https://sphinx-doc.org) to build and serve the documentation. You can build and serve the documentation locally | ||
|
||
```console | ||
sphinx-autobuild docs docs/_build/html --port=4001 | ||
``` | ||
Then just go to [localhost:4001](localhost:4001) and you can see the documentation. | ||
|
||
## LICENSE | ||
This software is copyrighted by Los Alamos National Laboratory and distributed according to the conditions in the accompanying [LICENSE](LICENSE) file. |
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