-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: fix documentation build and docs (#113)
- Loading branch information
Showing
2 changed files
with
17 additions
and
9 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,10 +1,16 @@ | ||
# doc generation directory # | ||
# Documentation | ||
|
||
This directory contains data related to sphinx doc generation | ||
To generate basic docs, run: | ||
`make html` | ||
`sphinx-build -b rinoh source _build/rinoh` | ||
This directory contains data related to Sphinx doc generation. To generate basic | ||
docs, run: | ||
|
||
**Do not** commit generated html files to version control. | ||
<!-- `none` is not a language but is required to satisfy SuperLinter in CI --> | ||
```none | ||
pip install -r requirements-doc.txt | ||
make html | ||
sphinx-build -b rinoh source _build/rinoh | ||
``` | ||
|
||
See [the docs](https://www.sphinx-doc.org/en/master/tutorial/index.html) for more information. | ||
**Do not** commit generated HTML files to version control. | ||
|
||
See [the Sphinx docs](https://www.sphinx-doc.org/en/master/tutorial/index.html) | ||
for more information. |
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,7 @@ | ||
# TODO(tk-woven) Bump mistune version when Sphinx API issue is fixed. | ||
# https://github.com/sphinx-contrib/openapi/issues/121 | ||
mistune==0.8.4 | ||
m2r2==0.3.1 | ||
rinohtype==0.5.3 | ||
m2r2==0.3.2 | ||
rinohtype==0.5.4 | ||
solar-theme==1.3.3 | ||
Sphinx==4.2.0 |