Skip to content

Commit

Permalink
[docs] remove cmake integration for docs, it was silly.
Browse files Browse the repository at this point in the history
  • Loading branch information
harrand committed Oct 30, 2024
1 parent 7952f2a commit 6eb4a19
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 33 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ jobs:
# You may pin to the exact commit or the version.
# uses: mattnotmitt/doxygen-action@547745274a4d97e6ca24901dc87c59e043a7e97e
uses: mattnotmitt/[email protected]
with:
working-directory: docs

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
Expand Down
1 change: 0 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ target_link_libraries(topaz PUBLIC textc_lib)
######################

set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
add_subdirectory(docs)
include(cmake/build_config.cmake)
setup_build_config()
include(cmake/compiler.cmake)
Expand Down
25 changes: 0 additions & 25 deletions docs/CMakeLists.txt

This file was deleted.

14 changes: 7 additions & 7 deletions docs/Doxyfile.in → docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ PROJECT_NAME = "Topaz"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
@INCLUDE = "@TOPAZ_VERSION_FILE@"
@INCLUDE = "../version.txt"

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand All @@ -73,7 +73,7 @@ PROJECT_ICON =
# entered, it will be relative to the location where Doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIR@"
OUTPUT_DIRECTORY = "./"

# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
Expand Down Expand Up @@ -820,7 +820,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = "@DOXYGEN_LAYOUT_FILE@"
LAYOUT_FILE = "./DoxygenLayout.xml"

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -964,8 +964,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = "@DOXYGEN_INPUT_DIR@"
INPUT += "@PROJECT_SOURCE_DIR@/README.md"
INPUT = "../include/tz"
INPUT += "../README.md"

# This tag can be used to specify the character encoding of the source files
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -1181,7 +1181,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the Doxygen output.

USE_MDFILE_AS_MAINPAGE = "@PROJECT_SOURCE_DIR@/README.md"
USE_MDFILE_AS_MAINPAGE = "../README.md"

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down Expand Up @@ -1421,7 +1421,7 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET = "@DOXYGEN_EXTRA_STYLESHEETS@"
HTML_EXTRA_STYLESHEET = "./doxygen-awesome.css"

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand Down

0 comments on commit 6eb4a19

Please sign in to comment.