Commit aec85e56 authored by Davide Cieri's avatar Davide Cieri
Browse files

conf

parent c0370eed

.readthedocs.yml

+1 −0
Original line number Diff line number Diff line
@@ -11,6 +11,7 @@ build: 
  tools:

    python: "3.8"





# Build documentation in the docs/ directory with Sphinx

sphinx:

 configuration: docs/conf.py

docs/conf.py

+11 −13
Original line number Diff line number Diff line
@@ -17,8 +17,8 @@ 
# -- Project information -----------------------------------------------------



project = 'Hog'

copyright = '2018-2022 The University of Birmingham'

author = 'N. Biesuz, D. Cieri, F. Gonnella, N. Giangiacomi, G. Loustau De Linares, A. Peck'

copyright = '2018-2024 The University of Birmingham'

author = 'N. Aranzabal, N. Biesuz, D. Cieri, F. Gonnella, N. Giangiacomi, G. Loustau De Linares, A. Peck'



# The full version, including alpha/beta/rc tags

#release = ''
@@ -29,16 +29,12 @@ author = 'N. Biesuz, D. Cieri, F. Gonnella, N. Giangiacomi, G. Loustau De Linare 
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = [

    "myst_parser",

    "sphinx_copybutton",

    "sphinx_togglebutton",

    "sphinx_thebe",

    "sphinx.ext.autodoc",

    "sphinx.ext.intersphinx",

    "sphinx.ext.viewcode",

    "sphinx_tabs.tabs",

    "sphinx_panels",

    "myst_parser", "sphinx_copybutton", "sphinx_togglebutton",

    "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode",

    'notfound.extension', "versionwarning.extension"

]

#"sphinx_tabs.tabs",



# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']
@@ -67,7 +63,8 @@ html_theme_options = { 
    # "use_edit_page_button": True,

    "use_issues_button": True,

    "use_repository_button": True,

    "expand_sections": ["reference/index"]

    "use_download_button": True

    # "expand_sections": ["reference/index"]

    # For testing

    # "home_page_in_toc": True,

    # "single_page": True
@@ -82,7 +79,6 @@ html_favicon = "custom/assets/images/hog.png" 
# 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"]



myst_enable_extensions = [

    "dollarmath",
@@ -97,3 +93,5 @@ myst_enable_extensions = [ 
myst_url_schemes = ("http", "https", "mailto")

myst_heading_anchors = 5

panels_add_boostrap_css = False



suppress_warnings = ["myst.header", "myst.lexing"]

requirements.txt

+6 −6
Original line number Diff line number Diff line 
myst_parser

sphinx_tabs

sphinx_panels

sphinx_book_theme>=0.0.36

sphinx_book_theme

sphinx_markdown_tables

sphinx_theme

sphinx_copybutton

sphinx_togglebutton

sphinx_thebe

sphinx>=3.4.2,<4

docutils<0.17,>=0.12

jinja2<3.1
 
 No newline at end of file
 
sphinx

docutils

jinja2

sphinx-version-warning

sphinx-notfound-page