diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2014-10-21 14:56:34 -0400 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2014-10-21 14:56:34 -0400 |
| commit | acd90677ef1ac0583cf4fe457236ff6e7d575845 (patch) | |
| tree | 0a853c6f5ef6880412ca9bea934609a1e7174a66 /doc | |
| parent | 446a8dc6ca827fe5e9c17f24ea7326338d10d9d6 (diff) | |
| download | oslosphinx-acd90677ef1ac0583cf4fe457236ff6e7d575845.tar.gz | |
Tighten up documentation
Remove some mostly empty pages and add a few section headings.
Change-Id: I5f0b99ce7573c60b741dd726e55f28cf3bf9f7fc
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/contributing.rst | 9 | ||||
| -rw-r--r-- | doc/source/index.rst | 14 | ||||
| -rw-r--r-- | doc/source/installation.rst | 7 | ||||
| -rw-r--r-- | doc/source/readme.rst | 1 | ||||
| -rw-r--r-- | doc/source/usage.rst | 18 |
5 files changed, 21 insertions, 28 deletions
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index ed77c12..2ca75d1 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,4 +1,5 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file +============== + Contributing +============== + +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 27475a8..24f424d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,18 +1,10 @@ -.. oslosphinx documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -oslosphinx -========== - -Contents: +============ + oslosphinx +============ .. toctree:: :maxdepth: 2 - readme - installation usage contributing diff --git a/doc/source/installation.rst b/doc/source/installation.rst deleted file mode 100644 index 8b0a364..0000000 --- a/doc/source/installation.rst +++ /dev/null @@ -1,7 +0,0 @@ -============ -Installation -============ - -At the command line:: - - $ pip install oslosphinx diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 38ba804..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst
\ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 63fb002..61c8fbd 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,15 @@ -======== -Usage -======== +================== + Using oslosphinx +================== -To use oslosphinx in a project:: +To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in +the ``conf.py`` file in your Sphinx project. - import oslosphinx
\ No newline at end of file +Incubating Projects +=================== + +If you are an incubating project, set:: + + html_theme_options = {'incubating': True} + +in your conf.py as well, to enable the Incubation theme. |