From 7dbcf22b52157c917bad9e3a60a4f7df5f693645 Mon Sep 17 00:00:00 2001 From: Paul Fultz II Date: Wed, 8 May 2024 09:21:34 -0500 Subject: [PATCH] Revert "Add configurations for ReadtheDocs" --- .github/dependabot.yml | 18 ---- .readthedocs.yaml | 18 ---- docs/doxygen/Doxyfile => Doxyfile | 110 ++++++++----------- docs/.gitignore | 5 - docs/conf.py | 35 ------- docs/index.rst | 6 -- docs/license.rst | 6 -- docs/sphinx/_toc.yml.in | 13 --- docs/sphinx/requirements.in | 1 - docs/sphinx/requirements.txt | 169 ------------------------------ 10 files changed, 44 insertions(+), 337 deletions(-) delete mode 100644 .github/dependabot.yml delete mode 100644 .readthedocs.yaml rename docs/doxygen/Doxyfile => Doxyfile (95%) delete mode 100644 docs/.gitignore delete mode 100644 docs/conf.py delete mode 100644 docs/index.rst delete mode 100644 docs/license.rst delete mode 100644 docs/sphinx/_toc.yml.in delete mode 100644 docs/sphinx/requirements.in delete mode 100644 docs/sphinx/requirements.txt diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index e7ac584..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,18 +0,0 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates - -version: 2 -updates: - - package-ecosystem: "pip" # See documentation for possible values - directory: "/docs/sphinx" # Location of package manifests - open-pull-requests-limit: 10 - schedule: - interval: "daily" - target-branch: "develop" - labels: - - "documentation" - - "dependencies" - reviewers: - - "samjwu" diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index b3299fa..0000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -version: 2 - -sphinx: - configuration: docs/conf.py - -formats: [htmlzip, pdf, epub] - -python: - install: - - requirements: docs/sphinx/requirements.txt - -build: - os: ubuntu-22.04 - tools: - python: "3.10" diff --git a/docs/doxygen/Doxyfile b/Doxyfile similarity index 95% rename from docs/doxygen/Doxyfile rename to Doxyfile index 28ffa01..b453872 100644 --- a/docs/doxygen/Doxyfile +++ b/Doxyfile @@ -52,7 +52,7 @@ PROJECT_LOGO = # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = . +OUTPUT_DIRECTORY = doc # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output @@ -667,7 +667,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ../../include/half.hpp +INPUT = include/half.hpp # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -888,65 +888,43 @@ HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = ../_doxygen/header.html - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = ../_doxygen/footer.html - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = ../_doxygen/stylesheet.css - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). -# Note: Since the styling of scrollbars can currently not be overruled in -# Webkit/Chromium, the styling will be left out of the default doxygen.css if -# one or more extra stylesheets have been specified. So if scrollbar -# customization is desired it has to be added explicitly. For an example see the -# documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. -HTML_EXTRA_STYLESHEET = ../_doxygen/extra_stylesheet.css +HTML_EXTRA_STYLESHEET = # 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 @@ -1174,7 +1152,7 @@ DISABLE_INDEX = NO # Since the tree basically has the same information as the tab index you # could consider to set DISABLE_INDEX to NO when enabling this option. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values # (range [0,1..20]) that doxygen will group on one line in the generated HTML @@ -1250,7 +1228,7 @@ MATHJAX_EXTENSIONS = # typically be disabled. For large projects the javascript based search engine # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. -SEARCHENGINE = NO +SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. @@ -1473,7 +1451,7 @@ MAN_LINKS = NO # generate an XML file that captures the structure of # the code including all documentation. -GENERATE_XML = YES +GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be @@ -1646,7 +1624,7 @@ TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = html/tagfile.xml +GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes @@ -1814,7 +1792,7 @@ DIRECTORY_GRAPH = YES # HTML_FILE_EXTENSION to xhtml in order to make the SVG files # visible in IE 9+ (other browsers do not have this requirement). -DOT_IMAGE_FORMAT = svg +DOT_IMAGE_FORMAT = png # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. @@ -1823,7 +1801,7 @@ DOT_IMAGE_FORMAT = svg # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files # visible. Older versions of IE do not have SVG support. -INTERACTIVE_SVG = YES +INTERACTIVE_SVG = NO # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 734b917..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -_build/ -_doxygen/ -sphinx/_toc.yml -doxygen/html/ -doxygen/xml/ diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index f027e34..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,35 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -import re - - -html_theme = "rocm_docs_theme" -html_theme_options = {"flavor": "rocm"} - -extensions = ["rocm_docs", "rocm_docs.doxygen"] -external_toc_path = "./sphinx/_toc.yml" -doxygen_root = "doxygen" -doxysphinx_enabled = True -doxygen_project = { - "name": "half", - "path": "doxygen/xml", -} - -with open('../CMakeLists.txt', encoding='utf-8') as f: - match = re.search(r'rocm_setup_version\(VERSION\s+([0-9.]+)', f.read()) - if not match: - raise ValueError("VERSION not found!") - version_number = match[1] - -version = version_number -release = version_number -html_title = f"half {version}" -project = "half" -author = "Advanced Micro Devices, Inc." -copyright = ( - "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved." -) diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index a1fd9b8..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,6 +0,0 @@ -======= -Home -======= - -.. include:: ../README.txt - :literal: diff --git a/docs/license.rst b/docs/license.rst deleted file mode 100644 index af0ca25..0000000 --- a/docs/license.rst +++ /dev/null @@ -1,6 +0,0 @@ -======= -License -======= - -.. include:: ../LICENSE.txt - :literal: diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in deleted file mode 100644 index 81b95ad..0000000 --- a/docs/sphinx/_toc.yml.in +++ /dev/null @@ -1,13 +0,0 @@ -# Anywhere {branch} is used, the branch name will be substituted. -# These comments will also be removed. -defaults: - numbered: False - maxdepth: 6 -root: index -subtrees: - - caption: API Reference - entries: - - file: doxygen/html/index - - caption: About - entries: - - file: license diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in deleted file mode 100644 index c48f551..0000000 --- a/docs/sphinx/requirements.in +++ /dev/null @@ -1 +0,0 @@ -rocm-docs-core[api_reference]==1.1.1 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt deleted file mode 100644 index 65df9c9..0000000 --- a/docs/sphinx/requirements.txt +++ /dev/null @@ -1,169 +0,0 @@ -# -# This file is autogenerated by pip-compile with Python 3.10 -# by the following command: -# -# pip-compile requirements.in -# -accessible-pygments==0.0.4 - # via pydata-sphinx-theme -alabaster==0.7.16 - # via sphinx -babel==2.14.0 - # via - # pydata-sphinx-theme - # sphinx -beautifulsoup4==4.12.3 - # via pydata-sphinx-theme -breathe==4.35.0 - # via rocm-docs-core -certifi==2024.2.2 - # via requests -cffi==1.16.0 - # via - # cryptography - # pynacl -charset-normalizer==3.3.2 - # via requests -click==8.1.7 - # via - # click-log - # doxysphinx - # sphinx-external-toc -click-log==0.4.0 - # via doxysphinx -cryptography==42.0.5 - # via pyjwt -deprecated==1.2.14 - # via pygithub -docutils==0.21.2 - # via - # breathe - # myst-parser - # pydata-sphinx-theme - # sphinx -doxysphinx==3.3.8 - # via rocm-docs-core -fastjsonschema==2.19.1 - # via rocm-docs-core -gitdb==4.0.11 - # via gitpython -gitpython==3.1.43 - # via rocm-docs-core -idna==3.7 - # via requests -imagesize==1.4.1 - # via sphinx -jinja2==3.1.3 - # via - # myst-parser - # sphinx -libsass==0.22.0 - # via doxysphinx -lxml==4.9.4 - # via doxysphinx -markdown-it-py==3.0.0 - # via - # mdit-py-plugins - # myst-parser -markupsafe==2.1.5 - # via jinja2 -mdit-py-plugins==0.4.0 - # via myst-parser -mdurl==0.1.2 - # via markdown-it-py -mpire==2.10.1 - # via doxysphinx -myst-parser==3.0.1 - # via rocm-docs-core -numpy==1.26.4 - # via doxysphinx -packaging==24.0 - # via - # pydata-sphinx-theme - # sphinx -pycparser==2.22 - # via cffi -pydata-sphinx-theme==0.15.2 - # via - # rocm-docs-core - # sphinx-book-theme -pygithub==2.3.0 - # via rocm-docs-core -pygments==2.17.2 - # via - # accessible-pygments - # mpire - # pydata-sphinx-theme - # sphinx -pyjson5==1.6.6 - # via doxysphinx -pyjwt[crypto]==2.8.0 - # via pygithub -pynacl==1.5.0 - # via pygithub -pyparsing==3.1.2 - # via doxysphinx -pyyaml==6.0.1 - # via - # myst-parser - # rocm-docs-core - # sphinx-external-toc -requests==2.31.0 - # via - # pygithub - # sphinx -rocm-docs-core[api_reference]==1.1.1 - # via -r requirements.in -smmap==5.0.1 - # via gitdb -snowballstemmer==2.2.0 - # via sphinx -soupsieve==2.5 - # via beautifulsoup4 -sphinx==7.3.7 - # via - # breathe - # myst-parser - # pydata-sphinx-theme - # rocm-docs-core - # sphinx-book-theme - # sphinx-copybutton - # sphinx-design - # sphinx-external-toc - # sphinx-notfound-page -sphinx-book-theme==1.1.2 - # via rocm-docs-core -sphinx-copybutton==0.5.2 - # via rocm-docs-core -sphinx-design==0.5.0 - # via rocm-docs-core -sphinx-external-toc==1.0.1 - # via rocm-docs-core -sphinx-notfound-page==1.0.0 - # via rocm-docs-core -sphinxcontrib-applehelp==1.0.8 - # via sphinx -sphinxcontrib-devhelp==1.0.6 - # via sphinx -sphinxcontrib-htmlhelp==2.0.5 - # via sphinx -sphinxcontrib-jsmath==1.0.1 - # via sphinx -sphinxcontrib-qthelp==1.0.7 - # via sphinx -sphinxcontrib-serializinghtml==1.1.10 - # via sphinx -tomli==2.0.1 - # via sphinx -tqdm==4.66.2 - # via mpire -typing-extensions==4.11.0 - # via - # pydata-sphinx-theme - # pygithub -urllib3==2.2.1 - # via - # pygithub - # requests -wrapt==1.16.0 - # via deprecated