Skip to content

Commit

Permalink
Update the documentation for refreshing the Read the Docs web (#499)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmallasen committed May 15, 2024
1 parent 16e4d37 commit 3a5b07b
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions docs/source/How_to/UpdateDocumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,24 @@ All documentation is found in the `/docs` directory.

1. If you need to create a new entry, add the new document in markdown (`.md` extension) to the corresponding folder. Otherwise, just edit the corresponding file.


> Make sure the document has one single `# header`, otherwise they will be considered different documents.

2. If a new folder is added, add it to the `toctree` inside `docs/source/index.rst` (as the `peripherals` folder is)
3. Commit and push
4. Once the branch is merged into the main branch of X-HEEP, anyone can open a terminal in the docs folder and run

## Refresh the web documentation

After each change to the documentation, once the branch is merged into the main branch of X-HEEP, anyone must do the following:

1. Open a terminal in the `docs` folder and make sure the conda environment is activated.
2. If it is your first time updating the web docs, run:
```bash
pip install -r requirements.txt
```
3. Run
```bash
make clean html
```
5. Wait a few minutes and enjoy your brand new documentation in Read the Docs.
4. Wait a few minutes and enjoy your brand new documentation in [Read the Docs](https://x-heep.readthedocs.io/en/latest/).

Thank you for helping keep X-HEEP accurately and extensively documented!
Thank you for helping keep X-HEEP accurately and extensively documented!

0 comments on commit 3a5b07b

Please sign in to comment.