mirror of https://github.com/McSinyx/palace
Use RTD theme for HTML documentation (fix GH-119)
This commit is contained in:
parent
74a9989e53
commit
1ba92b7c50
|
@ -35,7 +35,7 @@ jobs:
|
|||
cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr -S alure -B alure/build
|
||||
sudo cmake --build alure/build --parallel `nproc` --target install
|
||||
rm -fr alure
|
||||
python -m pip install Sphinx .
|
||||
python -m pip install Sphinx sphinx_rtd_theme .
|
||||
|
||||
- name: Build site
|
||||
working-directory: docs
|
||||
|
|
|
@ -27,11 +27,7 @@ templates_path = ['templates']
|
|||
exclude_patterns = []
|
||||
|
||||
# Options for HTML output
|
||||
html_theme = 'alabaster'
|
||||
html_theme_options = {'fixed_sidebar': True, 'show_relbars': True}
|
||||
|
||||
html_sidebars = {
|
||||
'**': ['globaltoc.html', 'quicknav.html', 'searchbox.html']}
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets)
|
||||
# here, relative to this directory. They are copied after the builtin
|
||||
|
|
|
@ -13,10 +13,8 @@ Palace wraps around the C++ interface alure_ using Cython_ for a safe and
|
|||
convenient interface with type hinting, data descriptors and context managers,
|
||||
following :pep:`8#naming-conventions` (``PascalCase.snake_case``).
|
||||
|
||||
Table of Contents
|
||||
-----------------
|
||||
|
||||
.. toctree::
|
||||
:caption: Table of Contents
|
||||
:maxdepth: 2
|
||||
|
||||
installation
|
||||
|
@ -26,6 +24,16 @@ Table of Contents
|
|||
contributing
|
||||
copying
|
||||
|
||||
.. toctree::
|
||||
:caption: Quick Navigation
|
||||
:hidden:
|
||||
|
||||
Python Package Index <https://pypi.org/project/palace/>
|
||||
Travis CI Build <https://travis-ci.com/github/McSinyx/palace>
|
||||
AppVeyor Build <https://ci.appveyor.com/project/McSinyx/palace>
|
||||
GitHub Repository <https://github.com/McSinyx/palace>
|
||||
Matrix Chat Room <https://matrix.to/#/#palace-dev:matrix.org>
|
||||
|
||||
Indices and Tables
|
||||
------------------
|
||||
|
||||
|
|
Loading…
Reference in New Issue