Skip to content

Commit f78ad3a

Browse files
authored
Automock pulseio so RTD can build the docs.
Also, fix DHTLib -> DHT
1 parent 18084c6 commit f78ad3a

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

conf.py

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,12 @@
1515
'sphinx.ext.viewcode',
1616
]
1717

18-
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
18+
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),
19+
'BusDevice': ('https://circuitpython.readthedocs.io/projects/bus_device/en/latest/', None),
20+
'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),
21+
'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
22+
23+
autodoc_mock_imports = ["pulseio"]
1924

2025
# Add any paths that contain templates here, relative to this directory.
2126
templates_path = ['_templates']
@@ -26,7 +31,7 @@
2631
master_doc = 'README'
2732

2833
# General information about the project.
29-
project = u'Adafruit DHTLIB Library'
34+
project = u'Adafruit CircuitPython DHT Library'
3035
copyright = u'2017 Mike McWethy'
3136
author = u'Mike McWethy'
3237

@@ -91,7 +96,7 @@
9196
html_static_path = ['_static']
9297

9398
# Output file base name for HTML help builder.
94-
htmlhelp_basename = 'AdafruitDHTLIBLibrarydoc'
99+
htmlhelp_basename = 'AdafruitCircuitPythonDHTLibrarydoc'
95100

96101
# -- Options for LaTeX output ---------------------------------------------
97102

@@ -117,7 +122,7 @@
117122
# (source start file, target name, title,
118123
# author, documentclass [howto, manual, or own class]).
119124
latex_documents = [
120-
(master_doc, 'AdafruitDHTLIBLibrary.tex', u'Adafruit DHTLIB Library Documentation',
125+
(master_doc, 'AdafruitCircuitPythonDHTLibrary.tex', u'Adafruit CircuitPython DHT Library Documentation',
121126
author, 'manual'),
122127
]
123128

@@ -126,7 +131,7 @@
126131
# One entry per manual page. List of tuples
127132
# (source start file, name, description, authors, manual section).
128133
man_pages = [
129-
(master_doc, 'adafruitDHTLIBlibrary', u'Adafruit DHTLIB Library Documentation',
134+
(master_doc, 'adafruitCircuitPythonDHTlibrary', u'Adafruit CircuitPython DHT Library Documentation',
130135
[author], 1)
131136
]
132137

@@ -136,7 +141,7 @@
136141
# (source start file, target name, title, author,
137142
# dir menu entry, description, category)
138143
texinfo_documents = [
139-
(master_doc, 'AdafruitDHTLIBLibrary', u'Adafruit DHTLIB Library Documentation',
140-
author, 'AdafruitDHTLIBLibrary', 'One line description of project.',
144+
(master_doc, 'AdafruitCircuitPythonDHTLibrary', u'Adafruit CircuitPython DHT Library Documentation',
145+
author, 'AdafruitCircuitPythonDHTLibrary', 'One line description of project.',
141146
'Miscellaneous'),
142147
]

0 commit comments

Comments
 (0)