diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6c71710f7..fa2e4e043 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,6 +12,6 @@ configuration: Doc/conf.py # Dependencies required to build your docs - # python: - # install: - # - requirements: docs/requirements.txt + python: + install: + - requirements: Doc/requirements.txt diff --git a/Doc/conf.py b/Doc/conf.py index bbdef7e1f..c77b33c70 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -92,7 +92,7 @@ current_year = datetime.date.today().year # General information about the project. project = u'MDANSE' -copyright = u'2015-' + str(current_year) + u', MDANSE is developed and supported by the Institut Laue-Langevin and the ISIS Neutron and Muon Source, ![UKRI Logo](_static/UKRI_Logo.png)' +copyright = u'2015-' + str(current_year) + u', MDANSE is developed and supported by the Institut Laue-Langevin and the ISIS Neutron and Muon Source.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -127,6 +127,14 @@ # Output file base name for HTML help builder. htmlhelp_basename = 'MDANSE_doc' +html_context = { + "display_github": True, # Integrate GitHub + "github_user": "ISISNeutronMuon", # Username + "github_repo": "MDANSE", # Repo name + "github_version": "protos", # Version + "conf_py_path": "/Doc/", # Path in the checkout to the docs root +} + latex_documents = [ (master_doc, 'theory_help.tex', 'Theory background of MDANSE', 'MDANSE developers', 'manual'), diff --git a/Doc/index.rst b/Doc/index.rst index e76adc62e..a940bf923 100644 --- a/Doc/index.rst +++ b/Doc/index.rst @@ -33,7 +33,7 @@ J Chem Inf Model. 57(1):1-5 (2017).