Skip to content

Commit

Permalink
fix: rtd build errors
Browse files Browse the repository at this point in the history
  • Loading branch information
redteampanda-ng committed Apr 2, 2024
1 parent 25599e6 commit 035b80b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 62 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
.vscode
_build
venv
.venv
74 changes: 13 additions & 61 deletions conf.py
Original file line number Diff line number Diff line change
@@ -1,79 +1,31 @@
# 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

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'ASGARD Inventory Analyzer Manual'
copyright = '2023, Nextron Systems'
author = 'Markus Meyer'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
version="1.0"
copyright = '2023, Nextron Systems GmbH'
author = 'Nextron Systems'
extensions = [
'sphinx.ext.autosectionlabel',
'sphinx_rtd_theme',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
source_suffix = '.rst'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv/*']
master_doc = 'index'
language = "en"
html_theme = 'sphinx_rtd_theme'

html_theme_options = {
'prev_next_buttons_location': 'both',
'style_external_links': True
}

html_logo = "images/html/inventory-logo.png"
html_favicon = "images/html/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
'css/custom.css',
]

# Master
master_doc = 'index'

# Enable -- to -
html_css_files = ['css/custom.css',]
epub_title = project
epub_exclude_files = ['search.html']
intersphinx_mapping = {'https://docs.python.org/': None}
smartquotes = False

# Use :ref: for subsections
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 3

# disable epub mimetype warnings
suppress_warnings = ["epub.unknown_project_files"]

0 comments on commit 035b80b

Please sign in to comment.