diff --git a/README.md b/README.md index a07dbc0..37d6598 100644 --- a/README.md +++ b/README.md @@ -2,37 +2,22 @@ This is an effort to produce high quality HTML documentation for GNU social in English. -To build the documentation simply run `php render.php`. The output HTML will be in the `rendered/` subfolder. +The documentation is produced using Python Sphinx, which uses a lightweight text-based markup. + +To build the documentation see README.sphinx. Rendered versions are available online: - User Guide - - Admin Guide - -## Editing - -- Add or edit HTML in `html/user/` or `html/admin` -- Add or edit images, etc., in `resources/user/` or `resources/admin` -- Ensure the page listing is up-to-date in `configs/user.config.php` and `configs/admin.config.php` -- Run `php render.php` and check it worked -- Submit a pull request so everybody gets smarter - -Various template substitutions are available. These are the most important ones. - - {HEADING:SECTION:section:My Heading} -- becomes an

with internal name "section" - {HEADING:SUBSECTION:subsection:My subheading} -- becomes an

with internal name "subsection" - {LINK:section} -- becomes an to appropriate_page.html#section - -- src is set to correct path for resource "foo.png" - ## License - Copyright 2016 Thomas Karpiniec . (If this ever becomes official documentation then obviously copyright will be assigned to the FSF.) - Copyright 2015 Free Software Foundation, Inc. - Copyright 2015 StatusNet, Inc -This documentation (under `html/` and `resources/`) is made available under the terms of the Creative Commons Attribution 3.0 Unported license. See for details. - -The renderer `render.php` is made available under the terms of the GNU General Public License version 3. See for details. +This documentation is made available under the terms of the Creative Commons Attribution 3.0 Unported license. See for details. ## Acknowledgements diff --git a/docs/conf.py b/docs/conf.py index ae738ae..4b8eec6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,9 +47,9 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'The Unofficial GNU Social User Manual' +project = u'The Unofficial GNU Social Manuals' copyright = u'2016, Thomas Karpiniec' -author = u'Thomas Karpiniec' +author = u'Various contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -109,13 +109,13 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'alabaster' +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 # documentation. html_theme_options = { - 'show_related': True, + } # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index fe91dd9..bcb39eb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,10 +16,4 @@ Contents: -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/user/exploring_the_network.rst b/docs/user/exploring.rst similarity index 100% rename from docs/user/exploring_the_network.rst rename to docs/user/exploring.rst diff --git a/docs/user/index.rst b/docs/user/index.rst index e157f6d..a6d6015 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -8,5 +8,5 @@ Contents: what_is_gnu_social getting_started - exploring_the_network - hashtags_and_groups + exploring + tags diff --git a/docs/user/hashtags_and_groups.rst b/docs/user/tags.rst similarity index 100% rename from docs/user/hashtags_and_groups.rst rename to docs/user/tags.rst diff --git a/requirements.txt b/requirements.txt index 6174f1b..9e8a279 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ Sphinx>=1.3.6 +sphinx_rtd_theme