Skip to content

Commit

Permalink
Add missing build dependencies to readthedoc files
Browse files Browse the repository at this point in the history
  • Loading branch information
MBartkowiakSTFC committed Apr 30, 2024
1 parent 3694932 commit 14d0ad5
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 19 deletions.
6 changes: 3 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
10 changes: 9 additions & 1 deletion Doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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'),
Expand Down
11 changes: 2 additions & 9 deletions Doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ J Chem Inf Model. 57(1):1-5 (2017).
<div class="grid-item">
<h3>💡 Explanations</h3>
<p>Learn the basics and core concepts of MDANSE.</p>
<a href="pages/explanations.html">Learn More</a>
<a href="pages/introduction.html">Learn More</a>
</div>
<div class="grid-item">
<h3>⚛️ How-To Guides</h3>
Expand All @@ -43,7 +43,7 @@ J Chem Inf Model. 57(1):1-5 (2017).
<div class="grid-item">
<h3>🧪 Tutorials</h3>
<p>Detailed tutorials to help you get started with MDANSE.</p>
<a href="pages/T_Batch.html">Learn More</a>
<a href="pages/T_Water_IR.html">Learn More</a>
</div>
<div class="grid-item">
<h3>📚 Technical References</h3>
Expand Down Expand Up @@ -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`
7 changes: 1 addition & 6 deletions Doc/pages/R_contact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<div style="background-color: black; padding: 10px; display: inline-block; border-radius: 5px;">
<a href="https://github.com/ISISNeutronMuon/MDANSE" style="color: white; text-decoration: none;">
<img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png" alt="GitHub Logo" style="vertical-align: middle; height: 20px; margin-right: 5px;">
MDANSE GitHub Repository
</a>
</div>
`MDANSE GitHub Page <https://github.com/ISISNeutronMuon/MDANSE>`_
1 change: 1 addition & 0 deletions Doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx-rtd-theme

0 comments on commit 14d0ad5

Please sign in to comment.