Skip to content

Commit

Permalink
Adding readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
erfanzar committed Nov 27, 2023
1 parent 857c393 commit 72b7096
Show file tree
Hide file tree
Showing 10 changed files with 226 additions and 545 deletions.
25 changes: 25 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "3.9"

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

# Optionally build your docs in additional formats such as PDF and ePub
formats:
- htmlzip

# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
55 changes: 0 additions & 55 deletions docs/CheckPointing.md

This file was deleted.

205 changes: 0 additions & 205 deletions docs/Optimizers.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/README.md

This file was deleted.

Loading

0 comments on commit 72b7096

Please sign in to comment.