Skip to content

Commit

Permalink
Convert C++ docs config to conf.py
Browse files Browse the repository at this point in the history
  • Loading branch information
parker-research committed Feb 24, 2025
1 parent 435c253 commit 3b044c8
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 15 deletions.
3 changes: 2 additions & 1 deletion docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ add_custom_command(
${CMAKE_CURRENT_BINARY_DIR}/warnings.dox
COMMAND "${CMAKE_COMMAND}" -E rm -rf ${CMAKE_CURRENT_BINARY_DIR}/html
${CMAKE_CURRENT_BINARY_DIR}/xml
COMMAND ${Python_EXECUTABLE} ${MCSS_DOXYGENPY_PATH} ${DOXYFILE_OUT}
COMMAND DOXYFILE_PATH=${DOXYFILE_OUT} ${Python_EXECUTABLE} ${MCSS_DOXYGENPY_PATH}
${PROJECT_SOURCE_DIR}/docs/conf.py
MAIN_DEPENDENCY ${DOXYFILE_OUT}
${DOXYFILE_IN}
COMMENT "Generating docs"
Expand Down
14 changes: 0 additions & 14 deletions docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,6 @@
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
# The default value is: UTF-8.

##! M_LINKS_NAVBAR1 = \
##! "user-manual command-line-ref language-support warning-ref tools" \
##! "developer-guide building commoncomp sourcemanagement diagnostics parsing"
##! M_LINKS_NAVBAR2 = \
##! "api-reference namespaces annotated files" \
##! "<a href="https://sv-lang.com/explore/">Try It</a>" \
##! "<a href="https://github.com/MikePopoloski/slang">GitHub</a>"
##! M_PAGE_FINE_PRINT = \
##! <p>slang SystemVerilog language services. Copyright (C) 2015-2025 Michael Popoloski.</br> \
##! Code is <a href="https://github.com/MikePopoloski/slang">available on GitHub</a> under the MIT license.</p>
##! M_SEARCH_DOWNLOAD_BINARY = YES
##! M_SEARCH_BASE_URL = https://sv-lang.com/
##! M_SEARCH_EXTERNAL_URL = "https://google.com/search?q=site:sv-lang.com+{query}"

DOXYFILE_ENCODING = UTF-8

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
Expand Down
51 changes: 51 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Docs: https://mcss.mosra.cz/documentation/doxygen/#configuration

import os

# File is generated from CMake, from "Doxyfile.in"
DOXYFILE = os.environ["DOXYFILE_PATH"]

LINKS_NAVBAR1 = [
(
"User Manual",
"user-manual",
[
("Command Line Reference", "command-line-ref"),
("Language Support", "language-support"),
("Warning Reference", "warning-ref"),
("Tools", "tools"),
],
),
(
"Developer Guide",
"developer-guide",
[
("Building", "building"),
("Common Components", "commoncomp"),
("Source Management", "sourcemanagement"),
("Diagnostics", "diagnostics"),
("Parsing", "parsing"),
],
),
]

LINKS_NAVBAR2 = [
(
"API Reference",
"api-reference",
[
("Namespaces", "namespaces"),
("Classes", "annotated"),
],
),
("Try It", "https://sv-lang.com/explore/", []),
("GitHub", "https://github.com/MikePopoloski/slang", []),
]

FINE_PRINT = (
"<p>slang SystemVerilog language services. Copyright (C) 2015-2025 Michael Popoloski.</br>"
'Code is <a href="https://github.com/MikePopoloski/slang">available on GitHub</a> under the MIT license.</p>'
)
SEARCH_DOWNLOAD_BINARY = True
SEARCH_BASE_URL = "https://sv-lang.com/"
SEARCH_EXTERNAL_URL = "https://google.com/search?q=site:sv-lang.com+{query}"

0 comments on commit 3b044c8

Please sign in to comment.