Improve docs. See: #38

cceh · Jan 12, 2020 · 9fd26cb · 9fd26cb
1 parent 10f4d64
commit 9fd26cb
Show file tree

Hide file tree

Showing 97 changed files with 733 additions and 483 deletions.
diff --git a/.gitignore b/.gitignore
@@ -28,4 +28,5 @@ Documents
 htdocs
 node_modules
 tools/reports
+tools/phpcs/OldSniffs
 vendor
diff --git a/Makefile b/Makefile
@@ -47,7 +47,8 @@ docs: doc_src/phpdoc/structure.xml doc_src/jsdoc/structure.json
 	cd doc_src && $(MAKE) -e html
 
 doccs: doc_src/phpdoc/structure.xml doc_src/jsdoc/structure.json
-	export SPHINXOPTS=-aE; cd doc_src && $(MAKE) -e html
+	$(RM) -r docs/*
+	cd doc_src && $(MAKE) -e html
 
 jsdoc: doc_src/jsdoc/structure.json
 

diff --git a/doc_src/Makefile b/doc_src/Makefile
@@ -50,7 +50,7 @@ clean:
 
 .PHONY: html
 html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR) # -a -E
+	$(SPHINXBUILD) -T -b html $(ALLSPHINXOPTS) $(BUILDDIR) # -a -E
 	cp _config.yml $(BUILDDIR)/
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)."

diff --git a/doc_src/autojsdoc b/doc_src/autojsdoc
@@ -0,0 +1 @@
+/home/highlander/uni/prj/sphinxcontrib/sphinxcontrib-autojsdoc/sphinxcontrib/
diff --git a/doc_src/autophpdoc b/doc_src/autophpdoc
@@ -0,0 +1 @@
+/home/highlander/uni/prj/sphinxcontrib/sphinxcontrib-autophpdoc/sphinxcontrib/
diff --git a/doc_src/conf.py b/doc_src/conf.py
@@ -43,22 +43,21 @@
     'sphinxcontrib.phpdomain',
     'autophpdoc.autophpdoc',
 
-    'sphinx_js',
     'autojsdoc.autojsdoc',
 
-    # 'xpath.xpath',
-    'sauml.sauml',
+    'sqlalchemy-uml.sqlalchemy-uml',
 ]
 
-#js_source_path = '../server/es6'
-#jsdoc_config_path = '../jsdoc.json'
-
 sauml_arguments = ['postgresql+psycopg2://capitularia@localhost:5432/capitularia']
 sauml_dot_table = 'bgcolor=#e7f2fa&color=#2980B9'
 
-# xpath_file    = 'phpdoc/structure.xml'
 autophpdoc_structure_xml = 'phpdoc/structure.xml'
+autophpdoc_members = True
+autophpdoc_title = True
+
 autojsdoc_structure_json = 'jsdoc/structure.json'
+autojsdoc_members = True
+autojsdoc_title = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/doc_src/index.rst b/doc_src/index.rst
@@ -1,4 +1,3 @@
-
 .. _contents:
 
 ===========================
@@ -26,10 +25,9 @@ Developer Manual
 
 
 
-..
-   Indices and tables
-   ==================
+Indices and tables
+==================
 
-   * :ref:`genindex`
-   * :ref:`modindex`
-   * :ref:`search`
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/doc_src/sauml b/doc_src/sauml
diff --git a/doc_src/sqlalchemy-uml b/doc_src/sqlalchemy-uml
@@ -0,0 +1 @@
+/home/highlander/uni/prj/sphinxcontrib/sphinxcontrib-sqlalchemy-uml/sphinxcontrib/
diff --git a/doc_src/webprojekt.rst b/doc_src/webprojekt.rst
@@ -9,3 +9,4 @@ RRZK Web Projekt Capitularia
 
    webprojekt/wordpress
    webprojekt/database
+   webprojekt/wordpress-custom
diff --git a/doc_src/webprojekt/database.rst b/doc_src/webprojekt/database.rst
@@ -1,8 +1,8 @@
 .. _mysql:
 .. _wp-db:
 
-Database Structure (Wordpress)
-==============================
+Wordpress Database Structure
+============================
 
 The Wordpress Database for Capitularia.  This is a mysql database that is a part
 of the "RRZK Webprojekt" package.

diff --git a/doc_src/webprojekt/wordpress-custom.rst b/doc_src/webprojekt/wordpress-custom.rst
@@ -0,0 +1,13 @@
+.. _wordpress:
+.. _wp:
+
+Wordpress Customizations
+========================
+
+The Wordpress customizations we did for Capitularia.
+
+.. toctree::
+   :maxdepth: 2
+
+   wordpress/theme
+   wordpress/plugins
diff --git a/doc_src/webprojekt/wordpress.rst b/doc_src/webprojekt/wordpress.rst
@@ -1,13 +1,16 @@
-.. _wordpress:
-.. _wp:
+Wordpress Installation
+======================
 
-Wordpress
-=========
+The Wordpress installation in the RRZK Webprojekt.
 
-The Wordpress installation for Capitularia.
+The installation resides in the directory:
+:file:`/afs/rrz.uni-koeln.de/vol/www/projekt/capitularia/http/docs/`.
 
-.. toctree::
-   :maxdepth: 2
+The web server has no write permission to the file system, so you cannot update
+Wordpress from the dashboard.  To update Wordpress, change into the installation
+directory and use the command :program:`wp` like this:
 
-   wordpress/theme
-   wordpress/plugins
+.. code:: shell
+
+   cd /afs/rrz.uni-koeln.de/vol/www/projekt/capitularia/http/docs/
+   ./wp core update
diff --git a/doc_src/webprojekt/wordpress/plugins/collation-tool.rst b/doc_src/webprojekt/wordpress/plugins/collation-tool.rst
@@ -7,9 +7,5 @@ Collation Tool
    :local:
 
 .. php:automodule:: cap-collation-user/cap-collation-user.php cap-collation-user/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/collation
-   :members:
-   :title:
diff --git a/doc_src/webprojekt/wordpress/plugins/dynamic-menu.rst b/doc_src/webprojekt/wordpress/plugins/dynamic-menu.rst
@@ -7,9 +7,5 @@ Dynamic Menu
    :local:
 
 .. php:automodule:: cap-dynamic-menu/cap-dynamic-menu.php cap-dynamic-menu/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/dynamic-menu
-   :members:
-   :title:
diff --git a/doc_src/webprojekt/wordpress/plugins/file-includer.rst b/doc_src/webprojekt/wordpress/plugins/file-includer.rst
@@ -7,9 +7,5 @@ File Includer
    :local:
 
 .. php:automodule:: cap-file-includer/cap-file-includer.php cap-file-includer/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/file-includer
-   :members:
-   :title:
diff --git a/doc_src/webprojekt/wordpress/plugins/lib.rst b/doc_src/webprojekt/wordpress/plugins/lib.rst
@@ -7,9 +7,5 @@ Library
    :local:
 
 .. php:automodule:: cap-lib/cap-lib.php cap-lib/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/lib
-   :members:
-   :title:
diff --git a/doc_src/webprojekt/wordpress/plugins/meta-search.rst b/doc_src/webprojekt/wordpress/plugins/meta-search.rst
@@ -7,9 +7,5 @@ Meta Search
    :local:
 
 .. php:automodule:: cap-meta-search/cap-meta-search.php cap-meta-search/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/meta-search
-   :members:
-   :title:
diff --git a/doc_src/webprojekt/wordpress/plugins/page-generator.rst b/doc_src/webprojekt/wordpress/plugins/page-generator.rst
@@ -7,9 +7,5 @@ Page Generator
    :local:
 
 .. php:automodule:: cap-page-generator/cap-page-generator.php cap-page-generator/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/page-generator
-   :members:
-   :title:
diff --git a/doc_src/webprojekt/wordpress/theme/main.rst b/doc_src/webprojekt/wordpress/theme/main.rst
@@ -9,9 +9,5 @@ The Wordpress theme for Capitularia.
    :local:
 
 .. php:automodule:: ^themes/Capitularia/[^/]+$
-   :members:
-   :title:
 
 .. js:automodule:: themes/capitularia
-   :members:
-   :title:
diff --git a/doc_src/webprojekt/wordpress/theme/widgets.rst b/doc_src/webprojekt/wordpress/theme/widgets.rst
@@ -9,9 +9,5 @@ The Widgets in the Wordpress theme for Capitularia.
    :local:
 
 .. php:automodule:: ^themes/Capitularia/widgets/
-   :members:
-   :title:
 
 .. js:automodule:: themes/capitularia/widgets
-   :members:
-   :title:
diff --git a/docs/_images/graphviz-08b4d97f8c149b86ccc6307d37e6f0aced746fff.png b/docs/_images/graphviz-08b4d97f8c149b86ccc6307d37e6f0aced746fff.png
diff --git a/docs/_images/graphviz-40c73cb7fa9f55141bdd5f11c7bafa4542498a03.png b/docs/_images/graphviz-40c73cb7fa9f55141bdd5f11c7bafa4542498a03.png
diff --git a/docs/_images/graphviz-724a3f592211f40261726a33c144a96ec2717e23.png b/docs/_images/graphviz-724a3f592211f40261726a33c144a96ec2717e23.png
diff --git a/docs/_images/graphviz-c8a17d4c8c280a95bd1395e71295a932a9f71b32.png b/docs/_images/graphviz-c8a17d4c8c280a95bd1395e71295a932a9f71b32.png
diff --git a/docs/_images/graphviz-cab436ba52b8b01cb556beaf16987f493808979f.png b/docs/_images/graphviz-cab436ba52b8b01cb556beaf16987f493808979f.png
diff --git a/docs/_images/graphviz-df128241e76a1cb63a5f31d9323e838cc8ce98ed.png b/docs/_images/graphviz-df128241e76a1cb63a5f31d9323e838cc8ce98ed.png
diff --git a/docs/_images/plantuml-4221c49e6f6f7f65c561e601c577315739d657d5.png b/docs/_images/plantuml-4221c49e6f6f7f65c561e601c577315739d657d5.png
diff --git a/docs/_images/plantuml-7328b0c7251de941a73aa19787156cc0fd222245.png b/docs/_images/plantuml-7328b0c7251de941a73aa19787156cc0fd222245.png
diff --git a/docs/_images/plantuml-99101418f7eeb7b5f4babfbad100ec775aa7d1aa.png b/docs/_images/plantuml-99101418f7eeb7b5f4babfbad100ec775aa7d1aa.png
diff --git a/docs/_images/plantuml-b8ba3c086c512ecc8134163470ca17192c0643f2.png b/docs/_images/plantuml-b8ba3c086c512ecc8134163470ca17192c0643f2.png
diff --git a/docs/_images/plantuml-ced332a40e59747acc98d16baa01ecf9b2ba3b6f.png b/docs/_images/plantuml-ced332a40e59747acc98d16baa01ecf9b2ba3b6f.png
diff --git a/docs/_images/plantuml-ea37bbc49aa3a4a6939cbfb700f715a317f7d973.png b/docs/_images/plantuml-ea37bbc49aa3a4a6939cbfb700f715a317f7d973.png
diff --git a/docs/_images/plantuml-fb6fe2e385f76014ced39dca6b873185a7e0e296.png b/docs/_images/plantuml-fb6fe2e385f76014ced39dca6b873185a7e0e296.png
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -1,4 +1,3 @@
-
 .. _contents:
 
 ===========================
@@ -26,10 +25,9 @@ Developer Manual
 
 
 
-..
-   Indices and tables
-   ==================
+Indices and tables
+==================
 
-   * :ref:`genindex`
-   * :ref:`modindex`
-   * :ref:`search`
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/webprojekt.rst.txt b/docs/_sources/webprojekt.rst.txt
@@ -9,3 +9,4 @@ RRZK Web Projekt Capitularia
 
    webprojekt/wordpress
    webprojekt/database
+   webprojekt/wordpress-custom
diff --git a/docs/_sources/webprojekt/database.rst.txt b/docs/_sources/webprojekt/database.rst.txt
@@ -1,8 +1,8 @@
 .. _mysql:
 .. _wp-db:
 
-Database Structure (Wordpress)
-==============================
+Wordpress Database Structure
+============================
 
 The Wordpress Database for Capitularia.  This is a mysql database that is a part
 of the "RRZK Webprojekt" package.

diff --git a/docs/_sources/webprojekt/wordpress-custom.rst.txt b/docs/_sources/webprojekt/wordpress-custom.rst.txt
@@ -0,0 +1,13 @@
+.. _wordpress:
+.. _wp:
+
+Wordpress Customizations
+========================
+
+The Wordpress customizations we did for Capitularia.
+
+.. toctree::
+   :maxdepth: 2
+
+   wordpress/theme
+   wordpress/plugins
diff --git a/docs/_sources/webprojekt/wordpress.rst.txt b/docs/_sources/webprojekt/wordpress.rst.txt
@@ -1,13 +1,16 @@
-.. _wordpress:
-.. _wp:
+Wordpress Installation
+======================
 
-Wordpress
-=========
+The Wordpress installation in the RRZK Webprojekt.
 
-The Wordpress installation for Capitularia.
+The installation resides in the directory:
+:file:`/afs/rrz.uni-koeln.de/vol/www/projekt/capitularia/http/docs/`.
 
-.. toctree::
-   :maxdepth: 2
+The web server has no write permission to the file system, so you cannot update
+Wordpress from the dashboard.  To update Wordpress, change into the installation
+directory and use the command :program:`wp` like this:
 
-   wordpress/theme
-   wordpress/plugins
+.. code:: shell
+
+   cd /afs/rrz.uni-koeln.de/vol/www/projekt/capitularia/http/docs/
+   ./wp core update
diff --git a/docs/_sources/webprojekt/wordpress/plugins/collation-tool.rst.txt b/docs/_sources/webprojekt/wordpress/plugins/collation-tool.rst.txt
@@ -7,9 +7,5 @@ Collation Tool
    :local:
 
 .. php:automodule:: cap-collation-user/cap-collation-user.php cap-collation-user/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/collation
-   :members:
-   :title:
diff --git a/docs/_sources/webprojekt/wordpress/plugins/dynamic-menu.rst.txt b/docs/_sources/webprojekt/wordpress/plugins/dynamic-menu.rst.txt
@@ -7,9 +7,5 @@ Dynamic Menu
    :local:
 
 .. php:automodule:: cap-dynamic-menu/cap-dynamic-menu.php cap-dynamic-menu/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/dynamic-menu
-   :members:
-   :title:
diff --git a/docs/_sources/webprojekt/wordpress/plugins/file-includer.rst.txt b/docs/_sources/webprojekt/wordpress/plugins/file-includer.rst.txt
@@ -7,9 +7,5 @@ File Includer
    :local:
 
 .. php:automodule:: cap-file-includer/cap-file-includer.php cap-file-includer/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/file-includer
-   :members:
-   :title:
diff --git a/docs/_sources/webprojekt/wordpress/plugins/lib.rst.txt b/docs/_sources/webprojekt/wordpress/plugins/lib.rst.txt
@@ -7,9 +7,5 @@ Library
    :local:
 
 .. php:automodule:: cap-lib/cap-lib.php cap-lib/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/lib
-   :members:
-   :title:
diff --git a/docs/_sources/webprojekt/wordpress/plugins/meta-search.rst.txt b/docs/_sources/webprojekt/wordpress/plugins/meta-search.rst.txt
@@ -7,9 +7,5 @@ Meta Search
    :local:
 
 .. php:automodule:: cap-meta-search/cap-meta-search.php cap-meta-search/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/meta-search
-   :members:
-   :title:
diff --git a/docs/_sources/webprojekt/wordpress/plugins/page-generator.rst.txt b/docs/_sources/webprojekt/wordpress/plugins/page-generator.rst.txt
@@ -7,9 +7,5 @@ Page Generator
    :local:
 
 .. php:automodule:: cap-page-generator/cap-page-generator.php cap-page-generator/
-   :members:
-   :title:
 
 .. js:automodule:: module:plugins/page-generator
-   :members:
-   :title:
diff --git a/docs/_sources/webprojekt/wordpress/theme/main.rst.txt b/docs/_sources/webprojekt/wordpress/theme/main.rst.txt
@@ -9,9 +9,5 @@ The Wordpress theme for Capitularia.
    :local:
 
 .. php:automodule:: ^themes/Capitularia/[^/]+$
-   :members:
-   :title:
 
 .. js:automodule:: themes/capitularia
-   :members:
-   :title:
diff --git a/docs/_sources/webprojekt/wordpress/theme/widgets.rst.txt b/docs/_sources/webprojekt/wordpress/theme/widgets.rst.txt
@@ -9,9 +9,5 @@ The Widgets in the Wordpress theme for Capitularia.
    :local:
 
 .. php:automodule:: ^themes/Capitularia/widgets/
-   :members:
-   :title:
 
 .. js:automodule:: themes/capitularia/widgets
-   :members:
-   :title:
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
diff --git a/docs/doctrees/vm/database.doctree b/docs/doctrees/vm/database.doctree
diff --git a/docs/doctrees/webprojekt.doctree b/docs/doctrees/webprojekt.doctree
diff --git a/docs/doctrees/webprojekt/database.doctree b/docs/doctrees/webprojekt/database.doctree
diff --git a/docs/doctrees/webprojekt/wordpress-custom.doctree b/docs/doctrees/webprojekt/wordpress-custom.doctree
diff --git a/docs/doctrees/webprojekt/wordpress.doctree b/docs/doctrees/webprojekt/wordpress.doctree
diff --git a/docs/doctrees/webprojekt/wordpress/plugins/collation-tool.doctree b/docs/doctrees/webprojekt/wordpress/plugins/collation-tool.doctree
diff --git a/docs/doctrees/webprojekt/wordpress/plugins/dynamic-menu.doctree b/docs/doctrees/webprojekt/wordpress/plugins/dynamic-menu.doctree
diff --git a/docs/doctrees/webprojekt/wordpress/plugins/file-includer.doctree b/docs/doctrees/webprojekt/wordpress/plugins/file-includer.doctree
diff --git a/docs/doctrees/webprojekt/wordpress/plugins/lib.doctree b/docs/doctrees/webprojekt/wordpress/plugins/lib.doctree
diff --git a/docs/doctrees/webprojekt/wordpress/plugins/meta-search.doctree b/docs/doctrees/webprojekt/wordpress/plugins/meta-search.doctree
diff --git a/docs/doctrees/webprojekt/wordpress/plugins/page-generator.doctree b/docs/doctrees/webprojekt/wordpress/plugins/page-generator.doctree
diff --git a/docs/doctrees/webprojekt/wordpress/theme/main.doctree b/docs/doctrees/webprojekt/wordpress/theme/main.doctree