diff options
| author |   Max Magorsch <max@magorsch.de> | 2020-01-19 02:13:38 +0100 |
|---|---|---|
| committer | Max Magorsch <max@magorsch.de> | 2020-01-19 02:13:38 +0100 |
| commit | 296dc1ae07948ce668dd5332e9b9465de53559df (patch) | |
| tree | 5af5871be9e235e4c09124500455a28fd28957b9 | |
| parent | Add package_data in the setup.py (diff) | |
| download | tyrian-sphinx-theme-296dc1ae07948ce668dd5332e9b9465de53559df.tar.gz tyrian-sphinx-theme-296dc1ae07948ce668dd5332e9b9465de53559df.tar.bz2 tyrian-sphinx-theme-296dc1ae07948ce668dd5332e9b9465de53559df.zip | |
Update the documentation
Signed-off-by: Max Magorsch <max@magorsch.de>
| -rw-r--r-- | README.md | 60 | ||||
| -rw-r--r-- | README.rst | 2 |
2 files changed, 60 insertions, 2 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..49b5e12 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Tyrian Sphinx Theme + +A Sphinx theme based on Tyrian (the new unified gentoo.org theme). + + +- [Installation](#installation) +- [Configuration](#configuration) + - [builders](#builders) + - [sidebar](#sidebar) + - [navigationlinks_top](#navigationlinks_top) + - [navigationlinks_bottom](#navigationlinks_bottom) + - [navigationlinks_navbar](#navigationlinks_navbar) +- [Contributors](#contributors) + +## Installation +You can install the theme using +``` shell +$ pip install git+https://github.com/mmagorsc/tyrian_sphinx_theme/#egg=tyrian_sphinx_theme +``` + +## Configuration +The appereance of the theme can be adjusted using different builders as well as further html_theme_options: + +### builders + +It is possible to use two different builders: +- html-builder *(default)*: Creates multiple pages, i.e. one page per file +- singlehtml-builder: Creates a single large page, containing the whole content + +You can specify the builder using sphinx command line options like: +``` +$ sphinx-build -b singlehtml ... +``` + +### sidebar + +- right *(default)*: display the sidebar on the right side of the page +- left: display the sidebar on the left side of the page +- none: don't display the sidebar on the page at all + +### navigationlinks_top + +- short: display the links using "<< >>" +- long: display the links using "<< chapter-heading chapter-heading >>" +- none *(default)*: don't display the navigation links on top at all + +### navigationlinks_bottom + +- short: display the links using "<< >>" +- long *(default)*: display the links using "<< chapter-heading chapter-heading >>" +- none: don't display the navigation links at the bottom at all + +### navigationlinks_navbar + +- short: display the links using "<< >>" +- long: display the links using "<< chapter-heading chapter-heading >>" +- none *(default)*: don't display the navigation links in the navbar at all + +## Contributors +* [Max Magorsch](mailto:max@magorsch.de)
\ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index b7daefb..0000000 --- a/README.rst +++ /dev/null @@ -1,2 +0,0 @@ -Tyrian Sphinx Theme -===================
\ No newline at end of file |