diff --git a/.gitignore b/.gitignore index 4c8414d28..63fb1b5b0 100644 --- a/.gitignore +++ b/.gitignore @@ -46,8 +46,14 @@ coverage.xml *.log local_settings.py -# Sphinx documentation -docs/_build/ +# Sphinx +docs/_build +docs/bin +docs/build +docs/include +docs/Lib +doc/pyvenv.cfg +pyvenv.cfg # PyBuilder target/ @@ -103,3 +109,13 @@ Pipfile *.bak /.cache/ /tmp/ + +# pyenv +/.python-version +/man/ +/.pytest_cache/ +lib64 +tcl + +# Ignore Jupyter Notebook related temp files +.ipynb_checkpoints/ diff --git a/.readthedocs.yml b/.readthedocs.yml index d5dde4cfd..683f3a82a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,12 +5,25 @@ # Required version: 2 +# Build in latest ubuntu/python +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build PDF & ePub +formats: + - epub + - pdf + # Where the Sphinx conf.py file is located sphinx: configuration: docs/source/conf.py -# Setting the doc build requirements +# Setting the python version and doc build requirements python: - version: "3.7" install: - - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: + - dev diff --git a/apache-2.0.LICENSE b/apache-2.0.LICENSE index d9a10c0d8..261eeb9e9 100644 --- a/apache-2.0.LICENSE +++ b/apache-2.0.LICENSE @@ -174,3 +174,28 @@ of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.