Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
chrischoy committed Apr 14, 2021
1 parent af1fdac commit 41f7ba4
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 332 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Include the markdown file in `index.rst` `toctree`.
You may modify the landing page `index.rst` itself in reStructuredText format.

## Generate HTML documentation website
`make html`
`cp ../README.md overview.md; make html`
You may ignore the consistency warning that README.md is not included in toctree. README.md is this file, the instruction to generate documentation website.
The website is generated in `_build/html`
331 changes: 0 additions & 331 deletions docs/overview.md

This file was deleted.

0 comments on commit 41f7ba4

Please sign in to comment.