Skip to content

Commit 2d0ce8e

Browse files
committed
Simplified document building
1 parent 701e446 commit 2d0ce8e

File tree

2 files changed

+5
-29
lines changed

2 files changed

+5
-29
lines changed

docs/conf.py

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@
1818
pygments_style = "sphinx"
1919
templates_path = ["_templates"]
2020

21-
# Check https://holzhaus.github.io/sphinx-multiversion/master/configuration.html#tag-branch-remote-whitelists
21+
# Check https://holzhaus.github.io/sphinx-multiversion/master/
22+
# configuration.html#tag-branch-remote-whitelists
2223
smv_tag_whitelist = None # Include no tags
23-
smv_branch_whitelist = r'^(master|develop)$' # Include develop branch
24+
smv_branch_whitelist = r'^(master)$' # Everything is on master now
2425
smv_remote_whitelist = r'^(origin|upstream)$' # Use origin and upstream
2526

2627
extensions = [
27-
'breathe', 'exhale', 'sphinx.ext.autosectionlabel', 'recommonmark',
28-
'sphinx_multiversion', 'sphinx.ext.graphviz'
28+
'sphinx.ext.autosectionlabel', 'recommonmark', 'sphinx_multiversion'
2929
]
3030

3131
html_theme_options = {
@@ -48,31 +48,14 @@
4848
'display_github': True,
4949
'github_repo': 'maplab',
5050
'github_user': 'ethz-asl',
51-
'github_version': 'develop',
51+
'github_version': 'master',
5252
'conf_py_path': '/docs/',
5353
}
5454

5555
templates_path = [
5656
"_templates",
5757
]
5858

59-
# Setup the breathe extension
60-
breathe_projects = {"project": "./doxyoutput/xml"}
61-
breathe_default_project = "project"
62-
63-
# Setup the exhale extension
64-
exhale_args = {
65-
"verboseBuild": False,
66-
"containmentFolder": "./api",
67-
"rootFileName": "library_root.rst",
68-
"rootFileTitle": "Library API",
69-
"doxygenStripFromPath": "..",
70-
"createTreeView": True,
71-
"exhaleExecutesDoxygen": True,
72-
"exhaleUseDoxyfile": True,
73-
"pageLevelConfigMeta":
74-
":github_url: https://github.com/ethz-asl/" + project
75-
}
7659
source_suffix = ['.rst', '.md']
7760

7861
# Tell sphinx what the primary language being documented is.

docs/index.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,6 @@
9191

9292
pages/additional-formats/*
9393

94-
.. toctree::
95-
:maxdepth: 3
96-
:caption: API
97-
:glob:
98-
99-
api/library_root
100-
10194

10295

10396
Indices and tables

0 commit comments

Comments
 (0)