Skip to content

Commit 9634611

Browse files
j2i2copybara-github
authored andcommitted
Create readthedocs config; add nbsphinx (for *.ipynb) as a requirement.
PiperOrigin-RevId: 323435175
1 parent c6a4555 commit 9634611

File tree

3 files changed

+67
-0
lines changed

3 files changed

+67
-0
lines changed

.readthedocs.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Copyright 2020 The Trax Authors.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# .readthedocs.yml
16+
# Read the Docs configuration file
17+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
18+
19+
# Required
20+
version: 2
21+
22+
# Build documentation in the docs/source directory with Sphinx.
23+
sphinx:
24+
configuration: docs/source/conf.py
25+
26+
# Build docs in additional formats (PDF, ePub).
27+
formats: all
28+
29+
# Optionally set the version of Python and requirements required to build your docs
30+
python:
31+
version: 3.7
32+
install:
33+
- requirements: docs/requirements.txt

docs/.readthedocs.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Copyright 2020 The Trax Authors.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# .readthedocs.yml
16+
# Read the Docs configuration file
17+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
18+
19+
# Required
20+
version: 2
21+
22+
# Build documentation in the docs/source directory with Sphinx.
23+
sphinx:
24+
configuration: docs/source/conf.py
25+
26+
# Build docs in additional formats (PDF, ePub).
27+
formats: all
28+
29+
# Optionally set the version of Python and requirements required to build your docs
30+
python:
31+
version: 3.7
32+
install:
33+
- requirements: docs/requirements.txt

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nbsphinx

0 commit comments

Comments
 (0)