diff --git a/docs/sphinx/_templates/layout.html b/docs/sphinx/_templates/layout.html
index dcf4cb0f..7e14c013 100644
--- a/docs/sphinx/_templates/layout.html
+++ b/docs/sphinx/_templates/layout.html
@@ -5,9 +5,11 @@
{{ title }}
{% endblock %}
+{% block sidebar1 %}{{ sidebar() }}{% endblock %}
+
{% block rootrellink %}
-
+
Home |
Search |
Gallery |
diff --git a/docs/sphinx/availability.py b/docs/sphinx/availability.py
index d6d187b6..681d430a 100644
--- a/docs/sphinx/availability.py
+++ b/docs/sphinx/availability.py
@@ -178,6 +178,7 @@ def depart_availability_node(self, node):
def setup(app):
app.add_javascript('javascript/header.js')
+
app.add_config_value('availability_include_availabilities', False, False)
app.add_node(availabilitylist)
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
index 5af9a344..32edb530 100644
--- a/docs/sphinx/conf.py
+++ b/docs/sphinx/conf.py
@@ -105,7 +105,7 @@ html_theme = 'default'
# 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
# documentation.
-html_theme_options = {'stickysidebar': 'true'}
+html_theme_options = {'collapsiblesidebar': 'true'}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
diff --git a/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst b/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst
index 4001985d..57661b86 100644
--- a/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst
+++ b/docs/sphinx/rest_substitutions/overviews/DocstringsGuidelines.rst
@@ -15,7 +15,7 @@ generated by parsing the wxWidgets XML docs; however, Phoenix has its own pure-P
functions and classes in at least two places:
* **Core Library**: examples include :ref:`CallLater` and :func:`date2pydate`, which require
- manual input od the documentation strings. This is achieved by editing the source Python files
+ manual input of the documentation strings. This is achieved by editing the source Python files
located in the ``etg`` folder in the Phoenix directory tree;
* **wx.lib**: the whole of ``wx.lib`` (and its sub-folders) is made up of pure-Python modules,
ofter representing owner-drawn widgets which are not available as wrapped modules. Again,
@@ -137,7 +137,7 @@ Will render as:
Currently, the `sphinx_generator` tool recognizes the following admonitions:
-1. ``.. note::`` : simple annotations to make a particular comment/sentence
+1. ``.. note::`` or ``:note:`` : simple annotations to make a particular comment/sentence
stand out against the rest of the documentation strings for a particular class, method or function;
2. ``.. warning::`` : this admonition normally indicates a problem or a severe limitation of a method,
class or function. In the Phoenix world, this may also indicate that a particular widget is not
@@ -145,7 +145,7 @@ Currently, the `sphinx_generator` tool recognizes the following admonitions:
3. ``.. deprecated::`` : used to mark deprecated methods, classes or functions;
4. ``.. availability::`` : normally employed to make the user understand on which platform(s) a particular
functionality is supported/available;
-5. ``.. seealso::`` : added primarily to facilitate the browsing of the docs, this admonition
+5. ``.. seealso::`` or ``:see:`` : added primarily to facilitate the browsing of the docs, this admonition
should be employed every time you think a user may be interested in seeing a related/similar method
or a function providing an alternative implementation;
6. ``.. todo::`` : used to mark incomplete methods/functions, or simply as a remainder for the user and
diff --git a/sphinxtools/postprocess.py b/sphinxtools/postprocess.py
index 1489cf59..782f2d48 100644
--- a/sphinxtools/postprocess.py
+++ b/sphinxtools/postprocess.py
@@ -142,8 +142,12 @@ def BuildEnumsAndMethods(sphinxDir):
text = text.replace('wx.``', '``')
text = text.replace('non-NULL', 'not ``None``')
text = text.replace(',,', ',').replace(', ,', ',')
- text = text.replace(':note:', '.. note::')
- text = text.replace(':see:', '.. seealso::')
+
+ if 'DocstringsGuidelines' not in input:
+ # Leave the DocstringsGuidelines.txt file alone on these ones
+ text = text.replace(':note:', '.. note::')
+ text = text.replace(':see:', '.. seealso::')
+
text = text.replace('`String`&', 'string')
text = text.replace('See also\n', '.. seealso:: ')
# Avoid Sphinx warnings on wx.TreeCtrl
@@ -151,6 +155,7 @@ def BuildEnumsAndMethods(sphinxDir):
# Replace EmptyString stuff
text = text.replace('EmptyString', "''")
# Replace ArrayString stuff...
+ text = text.replace('ArrayString()', '[]')
text = text.replace('ArrayString', 'list of strings')
if text != orig_text:
@@ -560,7 +565,7 @@ def PostProcess(folder):
if ''
- line = ClassToFile(line)
+## line = ClassToFile(line)
if index < len_split - 1: