Skip to content

Commit

Permalink
fix: fix documentation build and docs (#113)
Browse files Browse the repository at this point in the history
  • Loading branch information
tk-woven authored Aug 9, 2022
1 parent dcea28d commit bed9e4d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
20 changes: 13 additions & 7 deletions docs/README.md
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.
6 changes: 4 additions & 2 deletions docs/requirements-doc.txt
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

0 comments on commit bed9e4d

Please sign in to comment.