diff options
| author | Bobby <[email protected]> | 2022-08-30 18:13:03 -0400 |
|---|---|---|
| committer | Bobby <[email protected]> | 2022-08-30 18:13:03 -0400 |
| commit | b2026facd54d94c2145c48eeaac779672b0d9e80 (patch) | |
| tree | 3cd70e0fdff96ce26d009a75156ab752a84a2d74 /docs/conf.py | |
| download | edify-b2026facd54d94c2145c48eeaac779672b0d9e80.tar.xz edify-b2026facd54d94c2145c48eeaac779672b0d9e80.zip | |
Add initial project skeleton.
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..7a37755 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,47 @@ +# -*- coding: utf-8 -*- +from __future__ import unicode_literals + +import os + +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.coverage', + 'sphinx.ext.doctest', + 'sphinx.ext.extlinks', + 'sphinx.ext.ifconfig', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', +] +source_suffix = '.rst' +master_doc = 'index' +project = 'Edify' +year = '2022' +author = 'Bobby' +copyright = '{0}, {1}'.format(year, author) +version = release = '0.1.0' + +pygments_style = 'trac' +templates_path = ['.'] +extlinks = { + 'issue': ('https://github.com/luciferreeves/edify/issues/%s', '#'), + 'pr': ('https://github.com/luciferreeves/edify/pull/%s', 'PR #'), +} +# on_rtd is whether we are on readthedocs.org +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only set the theme if we're building docs locally + html_theme = 'sphinx_rtd_theme' + +html_use_smartypants = True +html_last_updated_fmt = '%b %d, %Y' +html_split_index = False +html_sidebars = { + '**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'], +} +html_short_title = '%s-%s' % (project, version) + +napoleon_use_ivar = True +napoleon_use_rtype = False +napoleon_use_param = False |
