BryanDavis has uploaded a new change for review.
https://gerrit.wikimedia.org/r/116457
Change subject: Update sphinx documentation
......................................................................
Update sphinx documentation
* Split up the documentation of scripts and the python API.
* Add documentation for mwversionsinuse.
* Set some global configuration for the autodoc module.
Change-Id: I455d9cc75fd0fd5d015b13fe39ced92d0e1fa228
---
A docs/api.rst
M docs/conf.py
M docs/index.rst
A docs/scripts.rst
4 files changed, 69 insertions(+), 61 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/tools/scap
refs/changes/57/116457/1
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..921e048
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,17 @@
+###
+API
+###
+
+.. automodule:: scap
+
+.. automodule:: scap.cli
+
+.. automodule:: scap.log
+
+.. automodule:: scap.main
+
+.. automodule:: scap.ssh
+
+.. automodule:: scap.tasks
+
+.. automodule:: scap.utils
diff --git a/docs/conf.py b/docs/conf.py
index fa3a9cd..d207d09 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -24,4 +24,5 @@
#html_static_path = ['_static']
htmlhelp_basename = 'scapdoc'
+autodoc_default_flags = ['members', 'private-members', 'special-members']
autodoc_memeber_order = 'groupwise'
diff --git a/docs/index.rst b/docs/index.rst
index bb34562..a0bee55 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,67 +1,19 @@
-####
-scap
-####
-Wikimedia Foundation's MediaWiki deploy scripts.
+##################
+Scap documentation
+##################
-*******
-Scripts
-*******
+**Scap** ("sync-common-all-php") is a collection of scripts used to publish
code
+and configuration to the Wikimedia Foundation production web servers.
-scap
-====
-``scap`` is the main MediaWiki deployment script. It is executed from
-``tin.eqiad.wmnet`` to push the contents of ``/a/common`` out to the
-production cluster.
+.. toctree::
+ :maxdepth: 2
-.. program-output:: ../bin/scap --help
-.. seealso::
- * :func:`scap.scap`
- * :func:`scap.tasks.scap`
+ scripts
+ api
-
-sync-common
-===========
-``sync-common`` uses rsync to fetch MediaWiki code and configuration to the
-local host.
-
-.. program-output:: ../bin/sync-common --help
-.. seealso::
- * :func:`scap.sync_common`
- * :func:`scap.tasks.sync_common`
-
-
-***
-API
-***
-
-.. automodule:: scap
- :members:
- :special-members:
-
-.. automodule:: scap.log
- :members:
- :special-members:
-
-.. automodule:: scap.main
- :members:
- :special-members:
-
-.. automodule:: scap.ssh
- :members:
- :special-members:
-
-.. automodule:: scap.tasks
- :members:
- :special-members:
-
-.. automodule:: scap.utils
- :members:
- :special-members:
-
-
-******************
Indices and tables
-******************
-* :ref:`genindex`
-* :ref:`search`
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/scripts.rst b/docs/scripts.rst
new file mode 100644
index 0000000..505e6f4
--- /dev/null
+++ b/docs/scripts.rst
@@ -0,0 +1,38 @@
+#######
+Scripts
+#######
+
+.. _scap:
+
+scap
+====
+**scap** is the driver script for syncing the MediaWiki versions and
+configuration files currently staged on ``tin.eqiad.wmnet`` to the rest of the
+production cluster.
+
+.. program-output:: ../bin/scap --help
+.. seealso::
+ * :func:`scap.scap`
+ * :func:`scap.tasks.scap`
+
+
+sync-common
+===========
+**sync-common** uses rsync to fetch MediaWiki code and configuration to the
+local host. It is typically called automatically on hosts during the execution
of scap_.
+
+.. program-output:: ../bin/sync-common --help
+.. seealso::
+ * :func:`scap.sync_common`
+ * :func:`scap.tasks.sync_common`
+
+
+mwversionsinuse
+===============
+**mwversionsinuse** examines wikiversions.json to find the current active
+MediaWiki versions.
+
+.. program-output:: ../bin/mwversionsinuse --help
+.. seealso::
+ * :func:`scap.MWVersionsInUse`
+ * :func:`scap.utils.wikiversions`
--
To view, visit https://gerrit.wikimedia.org/r/116457
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I455d9cc75fd0fd5d015b13fe39ced92d0e1fa228
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/tools/scap
Gerrit-Branch: master
Gerrit-Owner: BryanDavis <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
