Skip to content
This repository has been archived by the owner on Jun 4, 2021. It is now read-only.

Commit

Permalink
Merge branch 'develop' of https://github.com/cltl/pepper into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
selBaez committed May 26, 2020
2 parents 45e31a1 + 3968703 commit 305762c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
To add documentation:
1. Document code in [NumpyDoc](https://numpydoc.readthedocs.io/en/latest/format.html) format
2. Add additional text in ReStructuredText format
2. Make sure to ```pip install sphinx numpydoc sphinx_rtd_theme```
3. Make sure to ```(source) activate``` the pepper environment
2. Make sure to ```pip install sphinx numpydoc sphinx_rtd_theme```
4. Generate API documentation sources: ```make api```
5. Generate HTML pages from API documentation sources: ```make html```

Expand All @@ -17,4 +17,4 @@ Some Friendly Sphinx/ReStructuredText Reminders:
- Functions ``` :func:`~pepper.config.get_backend` ```
- Methods ``` :meth:`~pepper.brain.basic_brain.BasicBrain.get_classes` ```

- Add Links to External Resources: ``` `Text to Show <https://www.verynice.url.com>`_ ```
- Add Links to External Resources: ``` `Text to Show <https://www.verynice.url.com>`_ ```

0 comments on commit 305762c

Please sign in to comment.