Abhilash Raj pushed to branch master at GNU Mailman / Mailman Core
Commits:
fdc6eef6 by Abhilash Raj at 2019-10-13T07:48:06Z
Documentation re-arrangement.
- - - - -
8c8386fb by Abhilash Raj at 2019-10-13T08:29:57Z
Merge branch 'docs' into 'master'
Documentation re-arrangement.
See merge request mailman/mailman!566
- - - - -
4 changed files:
- README.rst
- conf.py
- src/mailman/rest/docs/rest.rst
- tox.ini
Changes:
=====================================
README.rst
=====================================
@@ -70,6 +70,16 @@ Table of Contents
src/mailman/docs/ACKNOWLEDGMENTS
+REST API
+--------
+
+.. toctree::
+ :maxdepth: 2
+ :caption: REST API
+
+ src/mailman/rest/docs/rest
+
+
Mailman modules
---------------
@@ -77,13 +87,13 @@ These documents are generated from the internal module
documentation.
.. toctree::
:maxdepth: 1
+ :caption: Mailman Modules
src/mailman/model/docs/model
src/mailman/runners/docs/runners
src/mailman/chains/docs/chains
src/mailman/rules/docs/rules
src/mailman/handlers/docs/handlers
- src/mailman/rest/docs/rest
src/mailman/core/docs/core
src/mailman/app/docs/app
src/mailman/styles/docs/styles
=====================================
conf.py
=====================================
@@ -95,7 +95,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
# 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
=====================================
src/mailman/rest/docs/rest.rst
=====================================
@@ -1,8 +1,8 @@
.. _rest-api:
-========================================
- Mailman 3 Core administrative REST API
-========================================
+========================
+ Mailman 3 Core REST API
+========================
Here is extensive documentation on the Mailman Core administrative REST API.
@@ -57,6 +57,8 @@ You can configure that in ``mailman.cfg`` configuration
file.::
REST credentials: restadmin:restpass
+REST API Documentation
+======================
.. toctree::
:glob:
@@ -78,4 +80,4 @@ You can configure that in ``mailman.cfg`` configuration
file.::
.. _`official Python bindings`: https://mailmanclient.readthedocs.io/en/latest/
.. _`mailman info`:
https://mailman.readthedocs.io/en/latest/src/mailman/config/docs/config.html#which-configuration-file-is-in-use
-.. _`Basic Operation`:
https://mailman.readthedocs.io/en/latest/src/mailman/rest/docs/basic.html#api-versions
\ No newline at end of file
+.. _`Basic Operation`:
https://mailman.readthedocs.io/en/latest/src/mailman/rest/docs/basic.html#api-versions
=====================================
tox.ini
=====================================
@@ -46,6 +46,7 @@ commands =
python setup.py build_sphinx
deps:
sphinx
+ sphinx_rtd_theme
docutils==0.12
[coverage]
View it on GitLab:
https://gitlab.com/mailman/mailman/compare/c634f06d6d98eb0d4b2bc19fa0239fb0fff1f17f...8c8386fbcbca02bca3150db7569242a2a050b4f8
--
View it on GitLab:
https://gitlab.com/mailman/mailman/compare/c634f06d6d98eb0d4b2bc19fa0239fb0fff1f17f...8c8386fbcbca02bca3150db7569242a2a050b4f8
You're receiving this email because of your account on gitlab.com.
_______________________________________________
Mailman-checkins mailing list
Mailman-checkins@python.org
Unsubscribe:
https://mail.python.org/mailman/options/mailman-checkins/archive%40jab.org
