widelands-dev team mailing list archive

[kaputtnik <somal@xxxxxxxx>]

kaputtnik has proposed merging lp:~widelands-dev/widelands/sphinx_remove_py_modindex into lp:widelands.

Commit message:
Let sphinx create an index but not a module index.

Requested reviews:
  Widelands Developers (widelands-dev)

For more details, see:
https://code.launchpad.net/~widelands-dev/widelands/sphinx_remove_py_modindex/+merge/345261

Let sphinx create an index but not a module index.

This is mainly because i can't get rid of the header saying 'Python Module Index' for the plan to use html pages directly for the website. But i think we have no modules at all?

Instead let sphinx create a general index of all functions which is alphabetical sorted.

-- 
Your team Widelands Developers is requested to review the proposed merge of lp:~widelands-dev/widelands/sphinx_remove_py_modindex into lp:widelands.

=== modified file 'doc/sphinx/source/conf.py'
--- doc/sphinx/source/conf.py	2017-08-28 06:34:49 +0000
+++ doc/sphinx/source/conf.py	2018-05-08 20:04:57 +0000
@@ -140,10 +140,10 @@
 #html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+html_domain_indices = False
 
 # If false, no index is generated.
-#html_use_index = True
+html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
 #html_split_index = False

=== modified file 'doc/sphinx/source/index.rst'
--- doc/sphinx/source/index.rst	2017-08-01 11:51:23 +0000
+++ doc/sphinx/source/index.rst	2018-05-08 20:04:57 +0000
@@ -21,6 +21,5 @@
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`