Skip to content

Commit f3e42c0

Browse files
committed
Build system improvements; Documentation WIP.
1 parent 557b7fe commit f3e42c0

File tree

2 files changed

+14
-26
lines changed

2 files changed

+14
-26
lines changed

documentation/CMakeLists.txt

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ if(${PROJECT_NAME}_WITH_HTML_DOCUMENTATION)
6262
OUTPUT "${_html_documentation_output}"
6363
COMMAND "${SPHINX_BUILD_EXECUTABLE}"
6464
-b html
65-
-Dproject="${PROJECT_NAME}"
66-
-Dversion="${PROJECT_VERSION}"
67-
-Drelease="${PROJECT_VERSION}"
65+
"-Dproject=${PROJECT_NAME}"
66+
"-Dversion=${PROJECT_VERSION}"
67+
"-Drelease=${PROJECT_VERSION}"
6868
${_html_theme_option}
69-
-Dhtml_title="${PROJECT_NAME}"
70-
-Dbreathe_default_project="${PROJECT_NAME}"
71-
-Dbreathe_projects.${PROJECT_NAME}="${_api_xml_output}"
69+
"-Dhtml_title=${PROJECT_NAME} Documentation"
70+
"-Dbreathe_default_project=${PROJECT_NAME}"
71+
"-Dbreathe_projects.${PROJECT_NAME}=${_api_xml_output}"
7272
"${CMAKE_CURRENT_SOURCE_DIR}"
7373
"${_html_documentation_output}"
7474
DEPENDS ${PROJECT_NAME}-API-XML
@@ -95,12 +95,11 @@ if(${PROJECT_NAME}_WITH_PDF_DOCUMENTATION)
9595
OUTPUT "${_latex_documentation_output}"
9696
COMMAND "${SPHINX_BUILD_EXECUTABLE}"
9797
-b latex
98-
-Dproject="${PROJECT_NAME}"
99-
-Dversion="${PROJECT_VERSION}"
100-
-Drelease="${PROJECT_VERSION}"
101-
-Dhtml_title="${PROJECT_NAME}"
102-
-Dbreathe_default_project="${PROJECT_NAME}"
103-
-Dbreathe_projects.${PROJECT_NAME}="${_api_xml_output}"
98+
"-Dproject=${PROJECT_NAME}"
99+
"-Dversion=${PROJECT_VERSION}"
100+
"-Drelease=${PROJECT_VERSION}"
101+
"-Dbreathe_default_project=${PROJECT_NAME}"
102+
"-Dbreathe_projects.${PROJECT_NAME}=${_api_xml_output}"
104103
"${CMAKE_CURRENT_SOURCE_DIR}"
105104
"${_latex_documentation_output}"
106105
DEPENDS ${PROJECT_NAME}-API-XML

documentation/index.rst

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,21 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
===
7-
Z80
8-
===
6+
========
7+
Contents
8+
========
99

1010
.. toctree::
1111
:maxdepth: 2
12-
:caption: Contents
1312

1413
Introduction
1514
InstallationFromSources
1615
Tests
1716
Integration
1817
Usage
1918
APIReference
20-
21-
.. toctree::
22-
:maxdepth: 2
23-
:caption: Project
24-
2519
Thanks
2620
VersionHistory
2721
License
28-
29-
.. toctree::
30-
:maxdepth: 2
31-
:caption: Indices and tables
32-
3322
genindex
3423
search

0 commit comments

Comments
 (0)