0.1.1: CSS Bugfixes and Documentation¶
TL;DR: This fixes a bug in the theme.css
, removes some text which was previously commented out, and adds documentation to this documentation.
theme.css
:
- Some of the .css was originally brought over from the
sphinx_rtd_theme
, but was commented out in0.1.0
. This has been removed. - The Table of Contents along the left of the screen (which scrolls with the user) had a bug where the
.current
class was set to usefont-weight: 900
. In reality this should have beena.current
, and has now been corrected in order to only bolden the current page’s link.
General Documentation changes:
- Changelog is now part of the documentation, and is stored under:
documentation/changelog/
. - New
.. toctree::
for the mainindex.rst
containing links to other relevant pages (in this case the GitHub and PyPi pages). source/index.rst
: Removed the part of the guide which suggested deleting thehtml_sidebars
dictionary fromconf.py
. This variable is necessary for the alabaster theme but it does not effectstarling-theme
; so including directions to remove it was unecessary.
User Guide:
- Guides on environment setup and downloading contain discussion on how to get started from a user’s perspective.
- An example for using
sphinx-quickstart
and switching out theconf.py
variables to usestarling-theme
are now included.
Developer Guide:
- Development Environment: Contains discussion on creating an Anaconda environment for developing the theme.
- Cloning from GitHub…: Contains discussion on cloning the repository from GitHub and installing a development build using
setup.py
.