Skip to content

Commit

Permalink
Resolve merge conflicts caused by RTD changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ModeSevenIndustrialSolutions committed Mar 13, 2024
2 parents e2bcada + c3f7367 commit 540c7d0
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 1 deletion.
95 changes: 95 additions & 0 deletions docs/conf.py.backup
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import os
import sys

# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath("../src/"))

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

#project = "PhysicalRisk"
#copyright = "2024, DCV"
#author = "DCV"

# The full version, including alpha/beta/rc tags
#release = "1.1.0"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

# The master toctree document.
master_doc = "index"

extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_toolbox.installation",
"sphinx_toolbox.latex",
"sphinx.ext.autosummary",
"sphinx.ext.graphviz",
"sphinx.ext.inheritance_diagram",
"sphinx.ext.autosectionlabel",
"sphinx_design",
"sphinx.ext.intersphinx",
# 'myst_nb',
# "myst_parser",
"nbsphinx",
# "sphinxcontrib.details"
"sphinxcontrib.bibtex",
"sphinx.ext.mathjax",
"sphinx_simplepdf",
]

bibtex_bibfiles = ["references.bib"]
bibtex_default_style = "alpha"
bibtex_encoding = "latin"

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# Not show module
python_module_index = False

# Summary
autosummary_generate = True

# Docstrings of private methods
autodoc_default_options = {"members": True, "undoc-members": True, "private-members": False}

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_logo = "images/OS-Climate-Logo.png"
html_theme = "pydata_sphinx_theme"
html_static_path = ["_static"]

# Don't show the code
html_show_sourcelink = True

html_theme_options = {
# 'logo_only': False,
# 'display_version': False,
# Table of contents options
"collapse_navigation": False,
}

html_sidebars = {
"**": [
"globaltoc.html", # Índice general
# 'localtoc.html', # Índice local para cada archivo
"searchbox.html", # Cuadro de búsqueda
]
}

# This setting ensures that each section in your documentation is automatically assigned
# a unique label based on the document it belongs to.
autosectionlabel_prefix_document = True

# show the members in the order they appear in the source code, you can use the autodoc_member_order option.
autodoc_member_order = "bysource"
1 change: 1 addition & 0 deletions docs/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
sphinx==5.3.0
sphinx-pyproject
numpydoc==1.0.0
sphinx-copybutton==0.5.0
myst-nb==0.16.0
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ include = ["physrisk*"]
test = [
"pdm[pytest]",
"pytest",
"pytest-cov"
"pytest-cov",
"sphinx-pyproject"
]
lint = [
"isort",
Expand Down

0 comments on commit 540c7d0

Please sign in to comment.