Skip to content

Commit

Permalink
docs: add ReadtheDocs config file .readthedocs.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
haote.yang committed May 18, 2021
1 parent d33a810 commit ff81d1c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# .readthedocs.yaml
# 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:
fail_on_warning: true

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: requirements.txt
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ It provides:
:caption: Quick Start

quick_start/getting_started_with_tensorbay
quick_start/examples
quick_start/examples_

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit ff81d1c

Please sign in to comment.