mirror of
https://github.com/huderlem/porymap.git
synced 2026-08-19 23:25:09 -05:00
Use rtd sphinx theme for docs and add docs README
This commit is contained in:
13
docsrc/README.md
Normal file
13
docsrc/README.md
Normal file
@@ -0,0 +1,13 @@
|
||||
This directory holds the sources that build the porymap documentation website. It uses Sphinx to build a static website, and copy the results to the `docs/` directory for GitHub Pages.
|
||||
|
||||
## Setup
|
||||
Sphinx uses Python, so you can use `pip` to install the dependencies:
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Build
|
||||
This will build the static site and copy the files to the root-level `docs/` directory. The GitHub Pages site will automatically update when the commit is merged to porymap's `master` branch.
|
||||
```
|
||||
make github
|
||||
```
|
||||
@@ -74,7 +74,7 @@ pygments_style = None
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
|
||||
2
docsrc/requirements.txt
Normal file
2
docsrc/requirements.txt
Normal file
@@ -0,0 +1,2 @@
|
||||
sphinx
|
||||
sphinx_rtd_theme
|
||||
Reference in New Issue
Block a user