Take jerrykan's sphinx work and tweak configs, update readmes
This commit is contained in:
parent
49c0114104
commit
b97d07d845
23
README.md
23
README.md
@ -2,37 +2,22 @@
|
|||||||
|
|
||||||
This is an effort to produce high quality HTML documentation for GNU social in English.
|
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:
|
Rendered versions are available online:
|
||||||
|
|
||||||
- User Guide - <https://karp.id.au/social/user/>
|
- User Guide - <https://karp.id.au/social/user/>
|
||||||
- Admin Guide - <https://karp.id.au/social/admin/>
|
- Admin Guide - <https://karp.id.au/social/admin/>
|
||||||
|
|
||||||
## 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 <h2> with internal name "section"
|
|
||||||
{HEADING:SUBSECTION:subsection:My subheading} -- becomes an <h3> with internal name "subsection"
|
|
||||||
{LINK:section} -- becomes an <a> to appropriate_page.html#section
|
|
||||||
<img src="{RES:foo.png}" /> -- src is set to correct path for resource "foo.png"
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
- Copyright 2016 Thomas Karpiniec <tk@1.21jiggawatts.net>. (If this ever becomes official documentation then obviously copyright will be assigned to the FSF.)
|
- Copyright 2016 Thomas Karpiniec <tk@1.21jiggawatts.net>. (If this ever becomes official documentation then obviously copyright will be assigned to the FSF.)
|
||||||
- Copyright 2015 Free Software Foundation, Inc.
|
- Copyright 2015 Free Software Foundation, Inc.
|
||||||
- Copyright 2015 StatusNet, 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 <http://creativecommons.org/licenses/by/3.0/> for details.
|
This documentation is made available under the terms of the Creative Commons Attribution 3.0 Unported license. See <http://creativecommons.org/licenses/by/3.0/> for details.
|
||||||
|
|
||||||
The renderer `render.php` is made available under the terms of the GNU General Public License version 3. See <https://www.gnu.org/licenses/gpl-3.0.html> for details.
|
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
|
@ -47,9 +47,9 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# 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'
|
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
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |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
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# 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
|
# 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
|
# further. For a list of options available for each theme, see the
|
||||||
# documentation.
|
# documentation.
|
||||||
html_theme_options = {
|
html_theme_options = {
|
||||||
'show_related': True,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
|
@ -16,10 +16,4 @@ Contents:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
||||||
|
|
||||||
|
@ -8,5 +8,5 @@ Contents:
|
|||||||
|
|
||||||
what_is_gnu_social
|
what_is_gnu_social
|
||||||
getting_started
|
getting_started
|
||||||
exploring_the_network
|
exploring
|
||||||
hashtags_and_groups
|
tags
|
||||||
|
@ -1 +1,2 @@
|
|||||||
Sphinx>=1.3.6
|
Sphinx>=1.3.6
|
||||||
|
sphinx_rtd_theme
|
||||||
|
Loading…
Reference in New Issue
Block a user