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/source/usage.rst | |
| 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/source/usage.rst')
| -rw-r--r-- | doc/source/usage.rst | 18 |
1 files changed, 13 insertions, 5 deletions
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. |