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).

๐Ÿ’ก Explanations

Learn the basics and core concepts of MDANSE.

- Learn More + Learn More

โš›๏ธ How-To Guides

@@ -43,7 +43,7 @@ J Chem Inf Model. 57(1):1-5 (2017).

๐Ÿงช Tutorials

Detailed tutorials to help you get started with MDANSE.

- Learn More + Learn More

๐Ÿ“š Technical References

@@ -105,10 +105,3 @@ J Chem Inf Model. 57(1):1-5 (2017). pages/R_units pages/R_further pages/references - -Indices and Tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/Doc/pages/R_contact.rst b/Doc/pages/R_contact.rst index 2c25d5a98..a41504755 100644 --- a/Doc/pages/R_contact.rst +++ b/Doc/pages/R_contact.rst @@ -29,9 +29,4 @@ GitHub Repository You can report issues and make suggestions on our GitHub repository. Please visit the following link to access the repository: -
- - GitHub Logo - MDANSE GitHub Repository - -
\ No newline at end of file +`MDANSE GitHub Page `_ diff --git a/Doc/requirements.txt b/Doc/requirements.txt new file mode 100644 index 000000000..6c5d5d44e --- /dev/null +++ b/Doc/requirements.txt @@ -0,0 +1 @@ +sphinx-rtd-theme