|
1 | 1 | #!/usr/bin/env python |
2 | | -# -*- coding: utf-8 -*- |
3 | 2 | # |
4 | | -# python_hll documentation build configuration file, created by |
| 3 | +# python_hll2 documentation build configuration file, created by |
5 | 4 | # sphinx-quickstart on Fri Jun 9 13:47:02 2017. |
6 | 5 | # |
7 | 6 | # This file is execfile()d with the current directory set to its |
|
20 | 19 | # |
21 | 20 | import os |
22 | 21 | import sys |
23 | | -sys.path.insert(0, os.path.abspath('..')) |
| 22 | +from pathlib import Path |
24 | 23 |
|
25 | | -import python_hll |
| 24 | +sys.path.insert(0, Path.resolve("..")) |
| 25 | + |
| 26 | +import python_hll2 |
26 | 27 |
|
27 | 28 | # -- General configuration --------------------------------------------- |
28 | 29 |
|
|
32 | 33 |
|
33 | 34 | # Add any Sphinx extension module names here, as strings. They can be |
34 | 35 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
35 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] |
| 36 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] |
36 | 37 |
|
37 | 38 | # Add any paths that contain templates here, relative to this directory. |
38 | | -templates_path = ['_templates'] |
| 39 | +templates_path = ["_templates"] |
39 | 40 |
|
40 | 41 | # The suffix(es) of source filenames. |
41 | 42 | # You can specify multiple suffix as a list of string: |
42 | 43 | # |
43 | 44 | # source_suffix = ['.rst', '.md'] |
44 | | -source_suffix = '.rst' |
| 45 | +source_suffix = ".rst" |
45 | 46 |
|
46 | 47 | # The master toctree document. |
47 | | -master_doc = 'index' |
| 48 | +master_doc = "index" |
48 | 49 |
|
49 | 50 | # General information about the project. |
50 | | -project = u'python-hll' |
51 | | -copyright = u"2019, Jon Aquino" |
52 | | -author = u"Jon Aquino" |
| 51 | +project = "python-hll2" |
| 52 | +copyright = "2019, Jon Aquino" |
| 53 | +author = "Jon Aquino" |
53 | 54 |
|
54 | 55 | # The version info for the project you're documenting, acts as replacement |
55 | 56 | # for |version| and |release|, also used in various other places throughout |
56 | 57 | # the built documents. |
57 | 58 | # |
58 | 59 | # The short X.Y version. |
59 | | -version = python_hll.__version__ |
| 60 | +version = python_hll2.__version__ |
60 | 61 | # The full version, including alpha/beta/rc tags. |
61 | | -release = python_hll.__version__ |
| 62 | +release = python_hll2.__version__ |
62 | 63 |
|
63 | 64 | # The language for content autogenerated by Sphinx. Refer to documentation |
64 | 65 | # for a list of supported languages. |
|
70 | 71 | # List of patterns, relative to source directory, that match files and |
71 | 72 | # directories to ignore when looking for source files. |
72 | 73 | # This patterns also effect to html_static_path and html_extra_path |
73 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 74 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
74 | 75 |
|
75 | 76 | # The name of the Pygments (syntax highlighting) style to use. |
76 | | -pygments_style = 'sphinx' |
| 77 | +pygments_style = "sphinx" |
77 | 78 |
|
78 | 79 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
79 | 80 | todo_include_todos = False |
|
84 | 85 | # The theme to use for HTML and HTML Help pages. See the documentation for |
85 | 86 | # a list of builtin themes. |
86 | 87 | # |
87 | | -html_theme = 'alabaster' |
| 88 | +html_theme = "alabaster" |
88 | 89 |
|
89 | 90 | # Theme options are theme-specific and customize the look and feel of a |
90 | 91 | # theme further. For a list of options available for each theme, see the |
|
95 | 96 | # Add any paths that contain custom static files (such as style sheets) here, |
96 | 97 | # relative to this directory. They are copied after the builtin static files, |
97 | 98 | # so a file named "default.css" will overwrite the builtin "default.css". |
98 | | -html_static_path = ['_static'] |
| 99 | +html_static_path = ["_static"] |
99 | 100 |
|
100 | 101 |
|
101 | 102 | # -- Options for HTMLHelp output --------------------------------------- |
102 | 103 |
|
103 | 104 | # Output file base name for HTML help builder. |
104 | | -htmlhelp_basename = 'python_hlldoc' |
| 105 | +htmlhelp_basename = "python_hlldoc" |
105 | 106 |
|
106 | 107 |
|
107 | 108 | # -- Options for LaTeX output ------------------------------------------ |
|
128 | 129 | # (source start file, target name, title, author, documentclass |
129 | 130 | # [howto, manual, or own class]). |
130 | 131 | latex_documents = [ |
131 | | - (master_doc, 'python_hll.tex', |
132 | | - u'python-hll Documentation', |
133 | | - u'Jon Aquino', 'manual'), |
| 132 | + (master_doc, "python_hll2.tex", |
| 133 | + "python-hll Documentation", |
| 134 | + "Jon Aquino", "manual"), |
134 | 135 | ] |
135 | 136 |
|
136 | 137 |
|
|
139 | 140 | # One entry per manual page. List of tuples |
140 | 141 | # (source start file, name, description, authors, manual section). |
141 | 142 | man_pages = [ |
142 | | - (master_doc, 'python_hll', |
143 | | - u'python-hll Documentation', |
| 143 | + (master_doc, "python_hll2", |
| 144 | + "python-hll Documentation", |
144 | 145 | [author], 1) |
145 | 146 | ] |
146 | 147 |
|
|
151 | 152 | # (source start file, target name, title, author, |
152 | 153 | # dir menu entry, description, category) |
153 | 154 | texinfo_documents = [ |
154 | | - (master_doc, 'python_hll', |
155 | | - u'python-hll Documentation', |
| 155 | + (master_doc, "python_hll2", |
| 156 | + "python-hll Documentation", |
156 | 157 | author, |
157 | | - 'python_hll', |
158 | | - 'One line description of project.', |
159 | | - 'Miscellaneous'), |
| 158 | + "python_hll2", |
| 159 | + "One line description of project.", |
| 160 | + "Miscellaneous"), |
160 | 161 | ] |
161 | 162 |
|
162 | 163 | # -- Make ReadTheDocs generate API doc ---------------------------------------- |
163 | 164 |
|
164 | 165 | # See https://github.com/isogeo/isogeo-api-py-minsdk/commit/df45262dae266035946839009e02e6c5e068a05f |
165 | | -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 166 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
166 | 167 | if on_rtd: |
167 | 168 | def run_apidoc(_): |
168 | 169 | from sphinx.apidoc import main as apidoc_main |
169 | 170 |
|
170 | 171 | cur_dir = os.path.abspath(os.path.dirname(__file__)) |
171 | | - output_path = os.path.join(cur_dir, 'docs') |
172 | | - modules = os.path.join(cur_dir, os.path.normpath(r"../python_hll")) |
| 172 | + output_path = os.path.join(cur_dir, "docs") |
| 173 | + modules = os.path.join(cur_dir, os.path.normpath(r"../python_hll2")) |
173 | 174 | exclusions = [] |
174 | | - apidoc_main([None, '-e', '-f', '-o', output_path, modules] + exclusions) |
| 175 | + apidoc_main([None, "-e", "-f", "-o", output_path, modules] + exclusions) |
175 | 176 |
|
176 | 177 | def setup(app): |
177 | | - app.connect('builder-inited', run_apidoc) |
| 178 | + app.connect("builder-inited", run_apidoc) |
0 commit comments