Skip to content

Commit

Permalink
setting up readthedoc build options
Browse files Browse the repository at this point in the history
  • Loading branch information
ArcticSnow committed Dec 3, 2020
1 parent 489774b commit 80b3d5e
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# .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 the docs/ directory with Sphinx
sphinx:
configuration: conf.py

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

# Optionally build your docs in additional formats such as PDF
formats:
- pdf
- epub

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

conda:
environment: environment.yml
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md','.readthedocs.yml']


# -- Options for HTML output -------------------------------------------------
Expand Down
51 changes: 51 additions & 0 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: docu_sphinx
channels:
- defaults
dependencies:
- _libgcc_mutex=0.1=main
- ca-certificates=2020.10.14=0
- certifi=2020.11.8=py39h06a4308_0
- ld_impl_linux-64=2.33.1=h53a641e_7
- libedit=3.1.20191231=h14c3975_1
- libffi=3.3=he6710b0_2
- libgcc-ng=9.1.0=hdf63c60_0
- libstdcxx-ng=9.1.0=hdf63c60_0
- ncurses=6.2=he6710b0_1
- openssl=1.1.1h=h7b6447c_0
- pip=20.3=py39h06a4308_0
- python=3.9.0=hdb3f193_2
- readline=8.0=h7b6447c_0
- setuptools=50.3.2=py39h06a4308_2
- sqlite=3.33.0=h62c20be_0
- tk=8.6.10=hbc83047_0
- tzdata=2020d=h14c3975_0
- wheel=0.36.0=pyhd3eb1b0_0
- xz=5.2.5=h7b6447c_0
- zlib=1.2.11=h7b6447c_3
- pip:
- alabaster==0.7.12
- babel==2.9.0
- chardet==3.0.4
- commonmark==0.9.1
- docutils==0.16
- idna==2.10
- imagesize==1.2.0
- jinja2==2.11.2
- markupsafe==1.1.1
- packaging==20.7
- pygments==2.7.2
- pyparsing==2.4.7
- pytz==2020.4
- recommonmark==0.6.0
- requests==2.25.0
- snowballstemmer==2.0.0
- sphinx==3.3.1
- sphinx-rtd-theme==0.5.0
- sphinxcontrib-applehelp==1.0.2
- sphinxcontrib-devhelp==1.0.2
- sphinxcontrib-htmlhelp==1.0.3
- sphinxcontrib-jsmath==1.0.1
- sphinxcontrib-qthelp==1.0.3
- sphinxcontrib-serializinghtml==1.1.4
- urllib3==1.26.2
prefix: /home/arcticsnow/miniconda3/envs/docu_sphinx

0 comments on commit 80b3d5e

Please sign in to comment.