Skip to content

Commit 8392cba

Browse files
committed
Add API docs to fluent.runtime
This adds the entry points to the fluent.runtime to the docs. I've abstracted the documentation from a single-person project a bit as I go.
1 parent 9f88c05 commit 8392cba

File tree

4 files changed

+15
-49
lines changed

4 files changed

+15
-49
lines changed

fluent.runtime/docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ help:
1616
# Catch-all target: route all unknown targets to Sphinx using the new
1717
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1818
%: Makefile
19-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

fluent.runtime/docs/conf.py

Lines changed: 8 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@
2020
# -- Project information -----------------------------------------------------
2121

2222
project = 'fluent.runtime'
23-
copyright = '2019, Luke Plant'
24-
author = 'Luke Plant'
23+
copyright = '2020'
2524

2625
# The short X.Y version
2726
version = '0.3'
@@ -41,6 +40,7 @@
4140
extensions = [
4241
'sphinx.ext.intersphinx',
4342
'sphinx.ext.viewcode',
43+
'sphinx.ext.autodoc',
4444
]
4545

4646
# Add any paths that contain templates here, relative to this directory.
@@ -128,56 +128,16 @@
128128

129129
# Grouping the document tree into LaTeX files. List of tuples
130130
# (source start file, target name, title,
131-
# author, documentclass [howto, manual, or own class]).
132-
latex_documents = [
133-
(master_doc, 'fluentruntime.tex', 'fluent.runtime Documentation',
134-
'Luke Plant', 'manual'),
135-
]
136-
137-
138-
# -- Options for manual page output ------------------------------------------
139-
140-
# One entry per manual page. List of tuples
141-
# (source start file, name, description, authors, manual section).
142-
man_pages = [
143-
(master_doc, 'fluentruntime', 'fluent.runtime Documentation',
144-
[author], 1)
145-
]
146-
147-
148-
# -- Options for Texinfo output ----------------------------------------------
149-
150-
# Grouping the document tree into Texinfo files. List of tuples
151-
# (source start file, target name, title, author,
152-
# dir menu entry, description, category)
153-
texinfo_documents = [
154-
(master_doc, 'fluentruntime', 'fluent.runtime Documentation',
155-
author, 'fluentruntime', 'One line description of project.',
156-
'Miscellaneous'),
157-
]
158-
159-
160-
# -- Options for Epub output -------------------------------------------------
161-
162-
# Bibliographic Dublin Core info.
163-
epub_title = project
164-
165-
# The unique identifier of the text. This can be a ISBN number
166-
# or the project homepage.
167-
#
168-
# epub_identifier = ''
169-
170-
# A unique identification for the text.
171-
#
172-
# epub_uid = ''
173-
174-
# A list of files that should not be packed into the epub file.
175-
epub_exclude_files = ['search.html']
176-
177131

178132
# -- Extension configuration -------------------------------------------------
179133

180134
# -- Options for intersphinx extension ---------------------------------------
181135

182136
# Example configuration for intersphinx: refer to the Python standard library.
183137
intersphinx_mapping = {'https://docs.python.org/': None}
138+
139+
# -- Options for autodoc extension --------------------------------------------
140+
141+
autodoc_mock_imports = [
142+
'attr',
143+
]

fluent.runtime/docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ significant changes.
1616
installation
1717
usage
1818
internals
19+
reference
1920
history

fluent.runtime/docs/reference.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
API Reference
2+
=============
3+
4+
.. automodule:: fluent.runtime
5+
:members:

0 commit comments

Comments
 (0)