Skip to content

Commit

Permalink
deploy: b9ae21d
Browse files Browse the repository at this point in the history
  • Loading branch information
twodrops committed Oct 12, 2023
1 parent 8108433 commit ffd802b
Show file tree
Hide file tree
Showing 321 changed files with 41,358 additions and 70,857 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 46f8222d47fe330ca8fd2207f9d213a2
config: fe6947f83fa26f50f8c2efc517f4b089
tags: 645f666f9bcd5a90fca523b33c5a78b7
1,292 changes: 539 additions & 753 deletions CONTRIBUTE.html

Large diffs are not rendered by default.

Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/classdoxysphinx_1_1rst_1_1Car-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
940 changes: 417 additions & 523 deletions _modules/click/core.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/cli.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/doxygen.html

Large diffs are not rendered by default.

816 changes: 333 additions & 483 deletions _modules/doxysphinx/html_parser.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/process.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/resources.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/sphinx.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/toc.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/utils/contexts.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/utils/exceptions.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/utils/files.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/utils/iterators.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/utils/pathlib_fix.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/utils/rst.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/doxysphinx/writer.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/index.html

Large diffs are not rendered by default.

814 changes: 332 additions & 482 deletions _modules/re.html

Large diffs are not rendered by default.

816 changes: 333 additions & 483 deletions _modules/typing.html

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Functions

.. py:class:: DoxygenContext
Represent the options for doxygen that can be set via the cli.

The doxygen projects are specified through INPUT (multiple possible). INPUT can be:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ Attributes
.. py:class:: DoxyOutput
Class to summarize the strings of the console output and error streams.

.. py:attribute:: out
Expand Down Expand Up @@ -75,6 +76,7 @@ Attributes

.. py:class:: DoxygenSettingsValidator
Validate doxygen settings for compatibility with doxysphinx.

Doxysphinx requires some settings to be present/set in a specific way.
Expand Down Expand Up @@ -125,6 +127,7 @@ Attributes

.. py:class:: DoxygenOutputPathValidator
Validates doxygen html output paths.

.. py:method:: validate(doxygen_html_output: pathlib.Path) -> bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Classes

.. py:class:: HtmlParseResult
Capsules a parsed and processed html tree with meta information.

.. py:attribute:: html_input_file
Expand Down Expand Up @@ -73,6 +74,7 @@ Classes

.. py:class:: HtmlParser(source_directory: pathlib.Path)
Bases: :py:obj:`Protocol`

.. autoapi-inheritance-diagram:: doxysphinx.html_parser.HtmlParser
Expand Down Expand Up @@ -101,6 +103,7 @@ Classes

.. py:class:: ElementProcessor
Bases: :py:obj:`Protocol`

.. autoapi-inheritance-diagram:: doxysphinx.html_parser.ElementProcessor
Expand Down Expand Up @@ -145,6 +148,7 @@ Classes

.. py:class:: RstInlineProcessor
Element Processor for inline rst elements.

.. py:attribute:: elements
Expand Down Expand Up @@ -177,6 +181,7 @@ Classes

.. py:class:: RstBlockProcessor
Element Processor for rst block elements.

.. py:attribute:: elements
Expand Down Expand Up @@ -205,6 +210,7 @@ Classes

.. py:class:: PreToDivProcessor
This Element Processor will change <pre>-tags to <div class="fragments"> tags.

We do this because doxysphinx will linearize html output in the writer to have it in one line in
Expand Down Expand Up @@ -239,6 +245,7 @@ Classes

.. py:class:: MarkdownRstBlockProcessor
Element Processor for doxygen markdown block elements.

This processor will check if the first line in the markdown block is either a supported marker or
Expand Down Expand Up @@ -288,6 +295,7 @@ Classes

.. py:class:: DoxygenHtmlParser(source_directory: pathlib.Path)
Parser for Doxygen HTML output files.

.. py:method:: parse(file: pathlib.Path) -> HtmlParseResult
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Classes

.. py:class:: Builder(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path, dir_mapper_type: Type[doxysphinx.sphinx.DirectoryMapper] = SphinxHtmlBuilderDirectoryMapper, resource_provider_type: Type[doxysphinx.resources.ResourceProvider] = DoxygenResourceProvider, parser_type: Type[doxysphinx.html_parser.HtmlParser] = DoxygenHtmlParser, writer_type: Type[doxysphinx.writer.Writer] = RstWriter, force_recreation: bool = False, parallel=True)
The Builder builds target docs-as-code files out of an existing html documentation.

For each an every html file a rst file is created that imports the html content
Expand All @@ -49,6 +50,7 @@ Classes

.. py:class:: Cleaner(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path, dir_mapper_type: Type[doxysphinx.sphinx.DirectoryMapper] = SphinxHtmlBuilderDirectoryMapper, resource_provider_type: Type[doxysphinx.resources.ResourceProvider] = DoxygenResourceProvider, parallel: bool = True)
The cleaner cleans files created and copied by the builder.

.. py:method:: cleanup(doxygen_html_dir: pathlib.Path)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Classes

.. py:class:: ResourceProvider(directory_mapper: doxysphinx.sphinx.DirectoryMapper)
Bases: :py:obj:`Protocol`

.. autoapi-inheritance-diagram:: doxysphinx.resources.ResourceProvider
Expand Down Expand Up @@ -60,6 +61,7 @@ Classes

.. py:class:: DoxygenResourceProvider(directory_mapper: doxysphinx.sphinx.DirectoryMapper)
Resource provider that will copy/adapt doxygen html resources to output.

Resource are e.g. stylesheets, images, javascript files etc.
Expand All @@ -82,6 +84,7 @@ Classes

.. py:class:: CssScoper(css_selector: str)
Scopes css-stylesheets to a special selector.

This is done with the help of libsass (as the sass-syntax extends css with nesting).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Classes

.. py:class:: DirectoryMapper(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path)
Bases: :py:obj:`Protocol`

.. autoapi-inheritance-diagram:: doxysphinx.sphinx.DirectoryMapper
Expand All @@ -46,6 +47,7 @@ Classes

.. py:class:: SphinxHtmlBuilderDirectoryMapper(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path)
Mapper that will calculate the output file path for an input file.

This is based on the logic that the sphinx html builder would use.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Classes

.. py:class:: TocGenerator(source_dir: pathlib.Path)
Bases: :py:obj:`Protocol`

.. autoapi-inheritance-diagram:: doxysphinx.toc.TocGenerator
Expand All @@ -47,6 +48,7 @@ Classes

.. py:class:: DoxygenTocGenerator(source_dir: pathlib.Path)
A TocGenerator for doxygen.

Will read the menudata.js to check whether a toctree
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Classes

.. py:class:: TimedContext
Bases: :py:obj:`object`

A context manager to measure elapsed time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Module Contents

.. py:exception:: ApplicationError(message)
Bases: :py:obj:`Exception`

.. autoapi-inheritance-diagram:: doxysphinx.utils.exceptions.ApplicationError
Expand All @@ -24,6 +25,7 @@ Module Contents

.. py:exception:: ValidationError(message)
Bases: :py:obj:`Exception`

.. autoapi-inheritance-diagram:: doxysphinx.utils.exceptions.ValidationError
Expand All @@ -34,6 +36,7 @@ Module Contents

.. py:exception:: PrerequisiteNotMetError(message)
Bases: :py:obj:`Exception`

.. autoapi-inheritance-diagram:: doxysphinx.utils.exceptions.PrerequisiteNotMetError
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Classes

.. py:class:: Writer(source_directory: pathlib.Path, toc_generator_type: Type[doxysphinx.toc.TocGenerator] = DoxygenTocGenerator)
Bases: :py:obj:`Protocol`

.. autoapi-inheritance-diagram:: doxysphinx.writer.Writer
Expand All @@ -47,6 +48,7 @@ Classes

.. py:class:: RstWriter(source_directory: pathlib.Path, toc_generator_type: Type[doxysphinx.toc.TocGenerator] = DoxygenTocGenerator)
Writes sphinx-rst files to disk.

.. py:method:: write(parse_result: doxysphinx.html_parser.HtmlParseResult, target_file: pathlib.Path, html_hash: str) -> pathlib.Path
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Large diffs are not rendered by default.

Empty file removed _static/__init__.py
Empty file.
Binary file removed _static/__pycache__/__init__.cpython-310.pyc
Binary file not shown.
55 changes: 26 additions & 29 deletions _static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -222,7 +222,7 @@ table.modindextable td {
/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 450px;
min-width: 360px;
max-width: 800px;
}

Expand All @@ -237,16 +237,6 @@ a.headerlink {
visibility: hidden;
}

a.brackets:before,
span.brackets > a:before{
content: "[";
}

a.brackets:after,
span.brackets > a:after {
content: "]";
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -335,12 +325,16 @@ p.sidebar-title {
font-weight: bold;
}

nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}

/* -- topics ---------------------------------------------------------------- */

nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
Expand Down Expand Up @@ -379,13 +373,17 @@ div.body p.centered {

div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}

div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
Expand Down Expand Up @@ -428,10 +426,6 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}

table.footnote td, table.footnote th {
border: 0 !important;
}

th {
text-align: left;
padding-right: 5px;
Expand Down Expand Up @@ -615,19 +609,26 @@ ul.simple p {
margin-bottom: 0;
}

dl.footnote > dt,
dl.citation > dt {
aside.footnote > span,
div.citation > span {
float: left;
margin-right: 0.5em;
}

dl.footnote > dd,
dl.citation > dd {
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}

dl.footnote > dd:after,
dl.citation > dd:after {
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
Expand All @@ -644,10 +645,6 @@ dl.field-list > dt {
padding-right: 5px;
}

dl.field-list > dt:after {
content: ":";
}

dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
Expand Down
2 changes: 0 additions & 2 deletions _static/css/blank.css

This file was deleted.

6 changes: 0 additions & 6 deletions _static/css/index.ff1ffe594081f20da1ef19478df9384b.css

This file was deleted.

Loading

0 comments on commit ffd802b

Please sign in to comment.