Skip to content

Commit d8cdaf4

Browse files
Add RTD build configuration from skeleton (#1337)
1 parent 79d833c commit d8cdaf4

File tree

3 files changed

+59
-5
lines changed

3 files changed

+59
-5
lines changed

.gitignore

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,14 @@ coverage.xml
4646
*.log
4747
local_settings.py
4848

49-
# Sphinx documentation
50-
docs/_build/
49+
# Sphinx
50+
docs/_build
51+
docs/bin
52+
docs/build
53+
docs/include
54+
docs/Lib
55+
doc/pyvenv.cfg
56+
pyvenv.cfg
5157

5258
# PyBuilder
5359
target/
@@ -103,3 +109,13 @@ Pipfile
103109
*.bak
104110
/.cache/
105111
/tmp/
112+
113+
# pyenv
114+
/.python-version
115+
/man/
116+
/.pytest_cache/
117+
lib64
118+
tcl
119+
120+
# Ignore Jupyter Notebook related temp files
121+
.ipynb_checkpoints/

.readthedocs.yml

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,25 @@
55
# Required
66
version: 2
77

8+
# Build in latest ubuntu/python
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build PDF & ePub
15+
formats:
16+
- epub
17+
- pdf
18+
819
# Where the Sphinx conf.py file is located
920
sphinx:
1021
configuration: docs/source/conf.py
1122

12-
# Setting the doc build requirements
23+
# Setting the python version and doc build requirements
1324
python:
14-
version: "3.7"
1525
install:
16-
- requirements: docs/requirements.txt
26+
- method: pip
27+
path: .
28+
extra_requirements:
29+
- dev

apache-2.0.LICENSE

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,3 +174,28 @@
174174
of your accepting any such warranty or additional liability.
175175

176176
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)