thomask/social-doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add copyright footer and update READMEs. Fixes #2

Browse Source
This commit is contained in:
Thomas Karpiniec 2018-03-26 20:09:52 +11:00
parent 69d897cf5e
commit 9552f145e2
3 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -8,27 +8,22 @@ 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 - <http://thomask.sdf.org/social/en/user/>
- Admin Guide - <https://karp.id.au/social/admin/> - Admin Guide - <http://thomask.sdf.org/social/en/admin/>
## 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 2018 Thomas Karpiniec <tk@1.21jiggawatts.net>.
- Copyright 2015 Free Software Foundation, Inc. - Copyright 2015 Free Software Foundation, Inc.
- Copyright 2015 StatusNet, Inc - Copyright 2015 StatusNet, Inc
- Contributors retain copyright of their work. See git history for details. Thank you:
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. @drymer, for the Spanish translation
## Contributors
A huge thank you to everybody who has contributed to these manuals:
Drymer, for the Spanish translation
Scott Bragg @faulteh Scott Bragg @faulteh
John Kristensen @jerrykan John Kristensen @jerrykan
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.
## Acknowledgements ## Acknowledgements
Much of the initial content is copied and adapted from the documentation in the main GNU social project at <https://git.gnu.io/gnu/gnu-social/> under the terms of Creative Commons Attribution 3.0 Unported license. Much of the initial content is copied and adapted from the documentation in the main GNU social project at <https://git.gnu.io/gnu/gnu-social/> under the terms of Creative Commons Attribution 3.0 Unported license.

7
README.sphinx
View File

@ -20,3 +20,10 @@ The documentation can be generated using the following commands
The documentation should now be available in `_build/` directory under the The documentation should now be available in `_build/` directory under the
`docs/` directory. `docs/` directory.
To generate the Spanish translations:
cd docs/
make translations
The Spanish version will be generated in `docs/_build/spanish`.

9
docs/conf.py
View File

@ -54,9 +54,9 @@ author = u'Various contributors'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = u'0.1.1' version = u'0.1.2'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = u'0.1.1' release = u'0.1.2'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -118,10 +118,11 @@ html_theme_options = {
html_context = { html_context = {
'show_sphinx': False, 'show_sphinx': False,
'show_copyright': False, 'show_copyright': True,
'show_source': False, 'show_source': False,
'build_id': subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]), 'build_id': subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]),
'build_url': 'https://git.gnu.io/tom/social-doc' 'build_url': 'https://git.gnu.io/tom/social-doc',
'copyright': "2018 Authors in README. Creative Commons CC-BY-3.0"
} }
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.