1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
# -*- coding: utf-8 -*-
import sys, re
from os.path import abspath
from pathlib import Path
from json import dump, loads
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.5'
extensions = [
# Standard Sphinx extensions
'recommonmark',
'sphinx.ext.autodoc',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.graphviz',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
# Other
'exec',
]
autodoc_default_options = {
"members": True,
'undoc-members': True,
#'private-members': True,
'inherited-members': True,
}
templates_path = ['_templates']
# The suffix(es) of source filenames.
source_suffix = {
'.rst': 'restructuredtext',
# '.txt': 'markdown',
'.md': 'markdown',
}
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'GHDL'
copyright = u'2002-2020, Tristan Gingold and contributors'
author = u'Tristan Gingold and contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
try:
with open('../configure') as verin:
for line in verin:
line = re.findall(r'ghdl_version=\"([0-9].+)\"', line)
if line:
version = line[0]
break
except Exception as e:
print('cannot extract version: %s' % e)
version = "latest"
pass
release = version # The full version, including alpha/beta/rc tags.
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
todo_link_only = True
# reST settings
prologPath = "prolog.inc"
try:
with open(prologPath, "r") as prologFile:
rst_prolog = prologFile.read()
except Exception as ex:
print("[ERROR:] While reading '{0!s}'.".format(prologPath))
print(ex)
rst_prolog = ""
# -- Options for HTML output ----------------------------------------------
html_theme_options = {
'logo_only': True,
'home_breadcrumbs': False,
'vcs_pageview_mode': 'blob',
}
html_context = {}
ctx = Path(__file__).resolve().parent / 'context.json'
if ctx.is_file():
html_context.update(loads(ctx.open('r').read()))
html_theme_path = ["."]
html_theme = "_theme"
html_static_path = ['_static']
html_extra_path = [str(Path(__file__).resolve().parent.parent / 'public')]
# Output file base name for HTML help builder.
htmlhelp_basename = 'GHDLdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
'papersize': 'a4paper',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'GHDL.tex', u'GHDL Documentation', author, 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'ghdl', u'GHDL Documentation', [author], 1)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author, dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'GHDL', u'GHDL Documentation', author, 'GHDL', 'VHDL simulator.', 'Miscellaneous'),
]
# -- Sphinx.Ext.InterSphinx -----------------------------------------------
intersphinx_mapping = {
'python': ('https://docs.python.org/3.6/', None),
'cosim': ('https://ghdl.github.io/ghdl-cosim', None),
'poc': ('https://poc-library.readthedocs.io/en/release', None)
}
# -- Sphinx.Ext.ExtLinks --------------------------------------------------
extlinks = {
'wikipedia': ('https://en.wikipedia.org/wiki/%s', None),
'ghdlsharp': ('https://github.com/ghdl/ghdl/issues/%s', '#'),
'ghdlissue': ('https://github.com/ghdl/ghdl/issues/%s', 'issue #'),
'ghdlpull': ('https://github.com/ghdl/ghdl/pull/%s', 'pull request #'),
'ghdlsrc': ('https://github.com/ghdl/ghdl/blob/master/src/%s', None)
}
|
