Skip to content

Commit

Permalink
Merge pull request #25 from MDIL-SNU/readthedocs
Browse files Browse the repository at this point in the history
Update about readthedocs
  • Loading branch information
hansw320b committed Aug 25, 2023
2 parents 447cf31 + b22c10c commit 722520a
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .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: docs/conf.py

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

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

# Optionally set the version of Python and requirements required to build your docs
build:
os: ubuntu-22.04
tools:
python: '3.7'



python:
install:
- requirements: docs/requirements.txt
4 changes: 4 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,7 @@ sh run.sh

The shell script file can be easily integrated with
job scheduler program such as portable batch system (PBS).


Installation, manual, and full details: https://amp2.readthedocs.io

1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx_rtd_theme

0 comments on commit 722520a

Please sign in to comment.