Skip to content

Commit e4c9422

Browse files
committed
🗑️ docs: Remove default placeholders from template
Getting ready to stage the actual Principles in the repo. Coming in the next commit. Signed-off-by: Justin W. Flory <git@jwf.io>
1 parent 029c061 commit e4c9422

File tree

3 files changed

+6
-87
lines changed

3 files changed

+6
-87
lines changed

docs/about/about-project.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/api/example-api-usage.rst

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/index.rst

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1-
.. sphinx-docs-opinionated-quickstart documentation master file, created by
2-
sphinx-quickstart on Mon Nov 5 13:02:02 2018.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
1+
#####################################
2+
Principles of Authentic Participation
3+
#####################################
54

6-
################################################
7-
sphinx-docs-opinionated-quickstart documentation
8-
################################################
9-
10-
This is the main page for the sphinx-docs-opinionated-quickstart documentation.
5+
This is the main page for the *Principles of Authentic Participation*.
116
Other pages are available for you to navigate and explore below.
12-
For more information, see the `repo on GitHub <https://github.com/jwflory/sphinx-docs-opinionated-quickstart>`_.
7+
For more information, see the `repo on GitHub <https://github.com/sustainers/authentic-participation>`_.
138

149
.. toctree::
1510
:maxdepth: 2
@@ -19,27 +14,9 @@ For more information, see the `repo on GitHub <https://github.com/jwflory/sphinx
1914

2015
about/*
2116

22-
.. toctree::
23-
:maxdepth: 2
24-
:name: api
25-
:caption: API:
17+
:caption: Principles:
2618
:glob:
2719

28-
api/*
29-
30-
31-
**********************************
32-
General advice on reStructuredText
33-
**********************************
34-
35-
Writing reStructuredText is not intuitive to a first-time author.
36-
Therefore, I find using a set of common standards is helpful to maintain style and consistency across documentation.
37-
For reStructuredText specifically, two places with helpful markup documentation are listed below:
38-
39-
* `Quick reStructuredText reference <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_
40-
* `Sphinx documentation <https://media.readthedocs.org/pdf/sphinx/stable/sphinx.pdf>`_
41-
42-
Additionally, I always use the `Sphinx style guide <https://documentation-style-guide-sphinx.readthedocs.io/>`_ for writing the same style across documents.
4320

4421

4522
******************

0 commit comments

Comments
 (0)