Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit a79e44d

Browse files
committed
update docs
1 parent ffa8bc3 commit a79e44d

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

docs/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,3 +176,9 @@
176176

177177
# A list of files that should not be packed into the epub file.
178178
epub_exclude_files = ['search.html']
179+
180+
# -- Setup for 'confval' used in docs/configuration.rst ----------------------
181+
182+
def setup(app):
183+
app.add_object_type('confval', 'confval',
184+
'pair: %s; configuration value')

docs/configuration.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Configuration
2+
=============
3+
4+
The following settings are available.
5+
You can customize these configuration options in your ``conf.py`` file:
6+
7+
.. confval:: rtd_sphinx_search_file_type
8+
9+
Description: Type of files to be included in the html.
10+
11+
Possible values:
12+
13+
- ``minified``: Include the minified and uglified CSS and JS files.
14+
- ``un-minified``: Include the original CSS and JS files.
15+
16+
Default: ``'minified'``
17+
18+
Type: ``string``

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ The CSS is also autoprefixed to extend the support to most of the browsers.
3939
:caption: Table of Contents
4040

4141
installation
42+
configuration
4243
custom-design
4344
development
4445
testing

0 commit comments

Comments
 (0)