Skip to content

Commit

Permalink
Add ReadTheDocs configuration for PR builds (#3060)
Browse files Browse the repository at this point in the history
 - Adds RTD configuration
 - Add `environment.yml` for package installation
  • Loading branch information
lilyminium authored Dec 10, 2020
1 parent 7746207 commit 2223363
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in with Sphinx
sphinx:
configuration: package/doc/sphinx/source/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml


# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7

conda:
environment: maintainer/conda/environment.yml
35 changes: 35 additions & 0 deletions maintainer/conda/environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: mda-dev
channels:
- defaults
- conda-forge
dependencies:
- chemfiles
- codecov
- cython
- griddataformats
- gsd
- h5py==2.10.0
- hypothesis
- joblib>=0.12
- matplotlib==3.2.2
- mmtf-python
- mock
- networkx
- numpy>=1.17.3
- psutil
- pytest
- scikit-learn
- scipy
- pip
- sphinx==1.8.5
- tidynamics>=1.0.0
- tqdm>=4.43.0
- sphinxcontrib-bibtex
- sphinx_rtd_theme
- pip:
- duecredit
- parmed
- msmb_theme==1.2.0
- sphinx-sitemap==1.0.2
- git+https://github.com/MDAnalysis/mdanalysis@develop#egg=mdanalysis&subdirectory=package
- git+https://github.com/MDAnalysis/mdanalysis@develop#egg=MDAnalysisTests&subdirectory=testsuite
3 changes: 2 additions & 1 deletion package/doc/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import os
import platform
import datetime
import MDAnalysis as mda
import msmb_theme # for little versions pop-up
# https://sphinx-rtd-theme.readthedocs.io/en/stable/
import sphinx_rtd_theme
Expand Down Expand Up @@ -68,7 +69,7 @@
# (take the list from AUTHORS)
# Ordering: (1) Naveen (2) Elizabeth, then all contributors in alphabetical order
# (last) Oliver
author_list = __import__('MDAnalysis').__authors__
author_list = mda.__authors__
authors = u', '.join(author_list[:-1]) + u', and ' + author_list[-1]
project = u'MDAnalysis'
now = datetime.datetime.now()
Expand Down

0 comments on commit 2223363

Please sign in to comment.