Skip to content

Commit

Permalink
WIP readthedocs build
Browse files Browse the repository at this point in the history
  • Loading branch information
timofeymukha committed Jun 4, 2022
1 parent f8c9b24 commit 28a52c3
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 4 deletions.
29 changes: 29 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
9 changes: 5 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,12 @@
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinxcontrib.bibtex',
#'sphinx.ext.intersphinx',
#'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.mathjax'
]


bibtex_bibfiles = "bibl.bib"

autodoc_mock_imports = ['mpi4py', "h5py"]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -84,7 +85,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mock
sphinxcontrib-bibtex
sphinx-rtd-theme

0 comments on commit 28a52c3

Please sign in to comment.