Skip to content

Commit

Permalink
update docs/CHANGES for 0.3. Re-enable search on docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
schettino72 committed Apr 19, 2019
1 parent fbce296 commit da931e2
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 4 deletions.
3 changes: 3 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
(in chronological order)

* Eduardo Schettino - schettino72 <at> gmail <dot> com
11 changes: 11 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
0.3.0 (*unreleased*)
====================

- require Sphinx >= 2.0
- inherit from `basic` theme (previously `none`)
- support search
- support showing logo
- add breadcrumbs
- add page navigation on page top


0.2.0 (*2019-03-19*)
====================

Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,11 @@
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.
# defined by theme itself.
#
# The default `html_sidebars` of Press theme: ['util/searchbox.html', 'util/sidetoc.html']
#
html_sidebars = {'**': ['util/sidetoc.html']}
# html_sidebars = {'**': ['util/sidetoc.html']}


# -- Options for HTMLHelp output ---------------------------------------------
Expand Down
18 changes: 16 additions & 2 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,25 @@ Jinja2 templates and blocks are organized as follow:
Config values
=============

``html_logo``
^^^^^^^^^^^^^

If defined shows an image instead of project name on page top-left (link to index page).

.. code-block:: python
html_logo = '_static/myproject-logo.png'
``html_sidebars``
^^^^^^^^^^^^^^^^^

By default the *sidebars* include only a global TOC tree.
By default the *sidebars* include only: searchbox and a global TOC tree.
See docs on `html_sidebars <http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars>`_.

.. code-block:: python
html_sidebars = {'**': ['util/sidetoc.html']}
html_sidebars = {'**': ['util/searchbox.html', 'util/sidetoc.html']}
Expand Down Expand Up @@ -84,6 +93,11 @@ Links taken from TOCs defined on master document.
External links defined by theme's user.


``util/searchbox.html``
^^^^^^^^^^^^^^^^^^^^^

Form to perform site search.

``util/sidetoc.html``
^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit da931e2

Please sign in to comment.