forked from dmikushin/tray
-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9c4801d
commit 23b4850
Showing
15 changed files
with
403 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| # .readthedocs.yaml | ||
| # Read the Docs configuration file | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
|
||
| version: 2 | ||
|
|
||
| build: | ||
| os: ubuntu-24.04 | ||
| tools: | ||
| python: "miniconda-latest" | ||
| commands: | ||
| # because we are overriding the build commands, we need to setup the environment ourselves | ||
| - cat docs/environment.yml | ||
| - conda env create --quiet --name ${READTHEDOCS_VERSION} --file docs/environment.yml | ||
| - mkdir -p ${READTHEDOCS_OUTPUT} | ||
| - | | ||
| wget "https://raw.githubusercontent.com/LizardByte/.github/master/branding/logos/favicon.ico" \ | ||
| -O ${READTHEDOCS_OUTPUT}lizardbyte.ico | ||
| - | | ||
| wget "https://raw.githubusercontent.com/LizardByte/.github/master/branding/logos/logo-128x128.png" \ | ||
| -O ${READTHEDOCS_OUTPUT}lizardbyte.png | ||
| - cd docs && doxygen Doxyfile | ||
|
|
||
| # using conda, we can get newer doxygen and graphviz than ubuntu provide | ||
| # https://github.com/readthedocs/readthedocs.org/issues/8151#issuecomment-890359661 | ||
| conda: | ||
| environment: docs/environment.yml | ||
|
|
||
| submodules: | ||
| include: all | ||
| recursive: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # find doxygen and graphviz | ||
| find_package(Doxygen | ||
| REQUIRED dot) | ||
|
|
||
| # define variables based on whether we are building on readthedocs | ||
| if(DEFINED ENV{READTHEDOCS}) | ||
| set(DOXYGEN_BUILD_DIR_CMAKE $ENV{READTHEDOCS_OUTPUT}) | ||
| set(DOXYGEN_PROJECT_VERSION $ENV{READTHEDOCS_VERSION}) | ||
| else() | ||
| set(DOXYGEN_BUILD_DIR_CMAKE "${CMAKE_CURRENT_BINARY_DIR}/build") | ||
| set(DOXYGEN_PROJECT_VERSION ${PROJECT_VERSION}) | ||
| endif() | ||
| message(STATUS "DOXYGEN_BUILD_DIR_CMAKE: ${DOXYGEN_BUILD_DIR_CMAKE}") | ||
|
|
||
| # download icon and logo | ||
| file(DOWNLOAD | ||
| "https://raw.githubusercontent.com/LizardByte/.github/master/branding/logos/favicon.ico" | ||
| "${DOXYGEN_BUILD_DIR_CMAKE}/lizardbyte.ico" | ||
| ) | ||
| file(DOWNLOAD | ||
| "https://raw.githubusercontent.com/LizardByte/.github/master/branding/logos/logo-128x128.png" | ||
| "${DOXYGEN_BUILD_DIR_CMAKE}/lizardbyte.png" | ||
| ) | ||
|
|
||
| # create build directories, as doxygen fails to create it in some cases? | ||
| file(MAKE_DIRECTORY "${DOXYGEN_BUILD_DIR_CMAKE}/html") | ||
|
|
||
| # convert to relative path, so doxygen doesn't get confused on Windows | ||
| file(RELATIVE_PATH DOXYGEN_BUILD_DIR_RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}" "${DOXYGEN_BUILD_DIR_CMAKE}") | ||
| message(STATUS "DOXYGEN_BUILD_DIR_RELATIVE: ${DOXYGEN_BUILD_DIR_RELATIVE}") | ||
|
|
||
| # build docs | ||
| add_custom_target(docs ALL | ||
| WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" | ||
| COMMENT "Building Doxygen documentation" | ||
| COMMAND ${CMAKE_COMMAND} -E env | ||
| READTHEDOCS_OUTPUT=${DOXYGEN_BUILD_DIR_RELATIVE} | ||
| READTHEDOCS_VERSION=${DOXYGEN_PROJECT_VERSION} | ||
| ${DOXYGEN_EXECUTABLE} Doxyfile | ||
| VERBATIM | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| # This file describes the settings to be used by the documentation system | ||
| # doxygen (www.doxygen.org) for a project. | ||
| # | ||
| # All text after a double hash (##) is considered a comment and is placed in | ||
| # front of the TAG it is preceding. | ||
| # | ||
| # All text after a single hash (#) is considered a comment and will be ignored. | ||
| # The format is: | ||
| # TAG = value [value, ...] | ||
| # For lists, items can also be appended using: | ||
| # TAG += value [value, ...] | ||
| # Values that contain spaces should be placed between quotes (\" \"). | ||
| # | ||
| # Note: | ||
| # | ||
| # Use doxygen to compare the used configuration file with the template | ||
| # configuration file: | ||
| # doxygen -x [configFile] | ||
| # Use doxygen to compare the used configuration file with the template | ||
| # configuration file without replacing the environment variables or CMake type | ||
| # replacement variables: | ||
| # doxygen -x_noenv [configFile] | ||
|
|
||
| # must be first | ||
| DOXYFILE_ENCODING = UTF-8 | ||
|
|
||
| # project metadata | ||
| DOCSET_BUNDLE_ID = dev.lizardbyte.tray | ||
| DOCSET_PUBLISHER_ID = dev.lizardbyte.tray.documentation | ||
| DOCSET_PUBLISHER_NAME = LizardByte | ||
| PROJECT_BRIEF = "Cross-platform, super tiny C99 implementation of a system tray icon with a popup menu and notifications." | ||
| PROJECT_ICON = $(READTHEDOCS_OUTPUT)/lizardbyte.ico | ||
| PROJECT_LOGO = $(READTHEDOCS_OUTPUT)/lizardbyte.png | ||
| PROJECT_NAME = tray | ||
|
|
||
| # project specific settings | ||
| DOT_GRAPH_MAX_NODES = 50 | ||
| IMAGE_PATH = ../docs/images | ||
| INCLUDE_PATH = | ||
| PREDEFINED = DOXYGEN | ||
| PREDEFINED += __APPLE__ | ||
| PREDEFINED += linux | ||
| PREDEFINED += __linux | ||
| PREDEFINED += __linux__ | ||
| PREDEFINED += __MACH__ | ||
| PREDEFINED += _WIN32 | ||
|
|
||
| # TODO: Enable this when we have complete documentation | ||
| WARN_IF_UNDOCUMENTED = NO | ||
|
|
||
| # files and directories to process | ||
| INPUT = ../README.md \ | ||
| ../src | ||
|
|
||
| # | ||
| # Common LizardByte settings | ||
| # | ||
|
|
||
| # doxygen-awesome-css | ||
| HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5 | ||
| HTML_COPY_CLIPBOARD = NO # required for Doxygen >= 1.10.0 | ||
| HTML_EXTRA_FILES = ../third-party/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js | ||
| HTML_EXTRA_FILES += ../third-party/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js | ||
| HTML_EXTRA_FILES += ../third-party/doxygen-awesome-css/doxygen-awesome-paragraph-link.js | ||
| HTML_EXTRA_FILES += ../third-party/doxygen-awesome-css/doxygen-awesome-interactive-toc.js | ||
| HTML_EXTRA_STYLESHEET = ../third-party/doxygen-awesome-css/doxygen-awesome.css | ||
| HTML_HEADER = header.html | ||
|
|
||
| # custom aliases | ||
| ALIASES = "" | ||
| ALIASES += "examples=^^**Examples**^^@code{.cpp}" | ||
| ALIASES += "examples_end=@endcode^^" | ||
| ALIASES += "rst=^^\verbatim embed:rst:leading-asterisk^^" | ||
| ALIASES += "rst_end=\endverbatim" | ||
|
|
||
| # general settings | ||
| CASE_SENSE_NAMES = YES | ||
| CREATE_SUBDIRS = NO | ||
| DISABLE_INDEX = NO | ||
| DOCBOOK_OUTPUT = docbook | ||
| DOT_IMAGE_FORMAT = svg | ||
| DOT_NUM_THREADS = 1 | ||
| EXTRACT_ALL = NO | ||
| FULL_SIDEBAR = NO | ||
| GENERATE_HTML = YES | ||
| GENERATE_LATEX = NO | ||
| GENERATE_TREEVIEW = YES | ||
| GENERATE_XML = NO | ||
| HAVE_DOT = YES | ||
| HTML_OUTPUT = html | ||
| INTERACTIVE_SVG = YES | ||
| LATEX_OUTPUT = latex | ||
| MACRO_EXPANSION = YES | ||
| MAN_OUTPUT = man | ||
| MARKDOWN_ID_STYLE = GITHUB | ||
| MARKDOWN_SUPPORT = YES | ||
| NUM_PROC_THREADS = 1 | ||
| PROJECT_NUMBER = $(READTHEDOCS_VERSION) | ||
| OUTPUT_DIRECTORY = $(READTHEDOCS_OUTPUT) | ||
| RECURSIVE = YES | ||
| RTF_OUTPUT = rtf | ||
| SORT_BRIEF_DOCS = YES | ||
| STRIP_FROM_INC_PATH = ../ | ||
| STRIP_FROM_PATH = ../ | ||
| WARN_AS_ERROR = FAIL_ON_WARNINGS | ||
| WARN_IF_DOC_ERROR = YES | ||
| WARN_IF_INCOMPLETE_DOC = YES | ||
| WARN_IF_UNDOC_ENUM_VAL = YES | ||
| WARN_NO_PARAMDOC = YES | ||
| WARNINGS = YES | ||
| XML_OUTPUT = xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| name: RTD | ||
| channels: | ||
| - conda-forge | ||
| - defaults | ||
| dependencies: | ||
| - doxygen=1.10.0 | ||
| - graphviz=11.0.0 |
Oops, something went wrong.