wolensing 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. wolensing-0.0.1/.github/workflows/pytest.yaml +39 -0
  2. wolensing-0.0.1/.github/workflows/testPyPl.yml +73 -0
  3. wolensing-0.0.1/.gitignore +9 -0
  4. wolensing-0.0.1/.ipynb_checkpoints/Untitled-checkpoint.ipynb +6 -0
  5. wolensing-0.0.1/.pytest_cache/.gitignore +2 -0
  6. wolensing-0.0.1/.pytest_cache/CACHEDIR.TAG +4 -0
  7. wolensing-0.0.1/.pytest_cache/README.md +8 -0
  8. wolensing-0.0.1/.pytest_cache/v/cache/lastfailed +1 -0
  9. wolensing-0.0.1/.pytest_cache/v/cache/nodeids +8 -0
  10. wolensing-0.0.1/.pytest_cache/v/cache/stepwise +1 -0
  11. wolensing-0.0.1/.readthedocs.yaml +64 -0
  12. wolensing-0.0.1/CITATION.cff +7 -0
  13. wolensing-0.0.1/LICENSE +21 -0
  14. wolensing-0.0.1/PKG-INFO +60 -0
  15. wolensing-0.0.1/README.rst +37 -0
  16. wolensing-0.0.1/docs/Makefile +20 -0
  17. wolensing-0.0.1/docs/build/doctrees/amplification_factor.doctree +0 -0
  18. wolensing-0.0.1/docs/build/doctrees/environment.pickle +0 -0
  19. wolensing-0.0.1/docs/build/doctrees/index.doctree +0 -0
  20. wolensing-0.0.1/docs/build/doctrees/lensmodels.doctree +0 -0
  21. wolensing-0.0.1/docs/build/doctrees/plot.doctree +0 -0
  22. wolensing-0.0.1/docs/build/doctrees/utils.doctree +0 -0
  23. wolensing-0.0.1/docs/build/html/.buildinfo +4 -0
  24. wolensing-0.0.1/docs/build/html/_modules/amplification_factor/amplification_factor.html +398 -0
  25. wolensing-0.0.1/docs/build/html/_modules/index.html +109 -0
  26. wolensing-0.0.1/docs/build/html/_modules/lensmodels/lens.html +271 -0
  27. wolensing-0.0.1/docs/build/html/_modules/lensmodels/potential.html +164 -0
  28. wolensing-0.0.1/docs/build/html/_modules/plot/plot.html +157 -0
  29. wolensing-0.0.1/docs/build/html/_modules/utils/histogram.html +454 -0
  30. wolensing-0.0.1/docs/build/html/_modules/utils/utils.html +248 -0
  31. wolensing-0.0.1/docs/build/html/_sources/amplification_factor.rst.txt +21 -0
  32. wolensing-0.0.1/docs/build/html/_sources/index.rst.txt +24 -0
  33. wolensing-0.0.1/docs/build/html/_sources/lensmodels.rst.txt +29 -0
  34. wolensing-0.0.1/docs/build/html/_sources/plot.rst.txt +21 -0
  35. wolensing-0.0.1/docs/build/html/_sources/utils.rst.txt +29 -0
  36. wolensing-0.0.1/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js +123 -0
  37. wolensing-0.0.1/docs/build/html/_static/basic.css +925 -0
  38. wolensing-0.0.1/docs/build/html/_static/css/badge_only.css +1 -0
  39. wolensing-0.0.1/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff +0 -0
  40. wolensing-0.0.1/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 +0 -0
  41. wolensing-0.0.1/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff +0 -0
  42. wolensing-0.0.1/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 +0 -0
  43. wolensing-0.0.1/docs/build/html/_static/css/fonts/fontawesome-webfont.eot +0 -0
  44. wolensing-0.0.1/docs/build/html/_static/css/fonts/fontawesome-webfont.svg +2671 -0
  45. wolensing-0.0.1/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf +0 -0
  46. wolensing-0.0.1/docs/build/html/_static/css/fonts/fontawesome-webfont.woff +0 -0
  47. wolensing-0.0.1/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 +0 -0
  48. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-bold-italic.woff +0 -0
  49. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 +0 -0
  50. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-bold.woff +0 -0
  51. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-bold.woff2 +0 -0
  52. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-normal-italic.woff +0 -0
  53. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 +0 -0
  54. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-normal.woff +0 -0
  55. wolensing-0.0.1/docs/build/html/_static/css/fonts/lato-normal.woff2 +0 -0
  56. wolensing-0.0.1/docs/build/html/_static/css/theme.css +4 -0
  57. wolensing-0.0.1/docs/build/html/_static/doctools.js +156 -0
  58. wolensing-0.0.1/docs/build/html/_static/documentation_options.js +13 -0
  59. wolensing-0.0.1/docs/build/html/_static/file.png +0 -0
  60. wolensing-0.0.1/docs/build/html/_static/jquery.js +2 -0
  61. wolensing-0.0.1/docs/build/html/_static/js/badge_only.js +1 -0
  62. wolensing-0.0.1/docs/build/html/_static/js/html5shiv-printshiv.min.js +4 -0
  63. wolensing-0.0.1/docs/build/html/_static/js/html5shiv.min.js +4 -0
  64. wolensing-0.0.1/docs/build/html/_static/js/theme.js +1 -0
  65. wolensing-0.0.1/docs/build/html/_static/language_data.js +199 -0
  66. wolensing-0.0.1/docs/build/html/_static/minus.png +0 -0
  67. wolensing-0.0.1/docs/build/html/_static/plus.png +0 -0
  68. wolensing-0.0.1/docs/build/html/_static/pygments.css +75 -0
  69. wolensing-0.0.1/docs/build/html/_static/searchtools.js +574 -0
  70. wolensing-0.0.1/docs/build/html/_static/sphinx_highlight.js +154 -0
  71. wolensing-0.0.1/docs/build/html/amplification_factor.html +239 -0
  72. wolensing-0.0.1/docs/build/html/genindex.html +380 -0
  73. wolensing-0.0.1/docs/build/html/index.html +149 -0
  74. wolensing-0.0.1/docs/build/html/lensmodels.html +297 -0
  75. wolensing-0.0.1/docs/build/html/objects.inv +0 -0
  76. wolensing-0.0.1/docs/build/html/plot.html +157 -0
  77. wolensing-0.0.1/docs/build/html/py-modindex.html +183 -0
  78. wolensing-0.0.1/docs/build/html/search.html +123 -0
  79. wolensing-0.0.1/docs/build/html/searchindex.js +1 -0
  80. wolensing-0.0.1/docs/build/html/utils.html +329 -0
  81. wolensing-0.0.1/docs/make.bat +35 -0
  82. wolensing-0.0.1/docs/source/amplification_factor.rst +21 -0
  83. wolensing-0.0.1/docs/source/conf.py +62 -0
  84. wolensing-0.0.1/docs/source/index.rst +24 -0
  85. wolensing-0.0.1/docs/source/lensmodels.rst +29 -0
  86. wolensing-0.0.1/docs/source/plot.rst +21 -0
  87. wolensing-0.0.1/docs/source/utils.rst +29 -0
  88. wolensing-0.0.1/pyproject.toml +34 -0
  89. wolensing-0.0.1/requirements.txt +9 -0
  90. wolensing-0.0.1/test/.pytest_cache/.gitignore +2 -0
  91. wolensing-0.0.1/test/.pytest_cache/CACHEDIR.TAG +4 -0
  92. wolensing-0.0.1/test/.pytest_cache/README.md +8 -0
  93. wolensing-0.0.1/test/.pytest_cache/v/cache/lastfailed +8 -0
  94. wolensing-0.0.1/test/.pytest_cache/v/cache/nodeids +8 -0
  95. wolensing-0.0.1/test/.pytest_cache/v/cache/stepwise +1 -0
  96. wolensing-0.0.1/test/__init__.py +0 -0
  97. wolensing-0.0.1/test/amplification_factor_test.py +110 -0
  98. wolensing-0.0.1/test/conftest.py +64 -0
  99. wolensing-0.0.1/test/test_sis_F_tilde.txt +12999 -0
  100. wolensing-0.0.1/test/test_sis_Fws.txt +20260 -0
  101. wolensing-0.0.1/test/test_sis_ts.txt +12999 -0
  102. wolensing-0.0.1/test/test_sis_ws.txt +20260 -0
  103. wolensing-0.0.1/wolensing/__about__.py +1 -0
  104. wolensing-0.0.1/wolensing/amplification_factor/.ipynb_checkpoints/amplification_factor-checkpoint.py +266 -0
  105. wolensing-0.0.1/wolensing/amplification_factor/__init__.py +0 -0
  106. wolensing-0.0.1/wolensing/amplification_factor/amplification_factor.py +305 -0
  107. wolensing-0.0.1/wolensing/lensmodels/.ipynb_checkpoints/hessian-checkpoint.py +58 -0
  108. wolensing-0.0.1/wolensing/lensmodels/.ipynb_checkpoints/lens-checkpoint.py +146 -0
  109. wolensing-0.0.1/wolensing/lensmodels/.ipynb_checkpoints/ok-checkpoint.ipynb +1 -0
  110. wolensing-0.0.1/wolensing/lensmodels/.ipynb_checkpoints/test-checkpoint.py +32 -0
  111. wolensing-0.0.1/wolensing/lensmodels/__init__.py +0 -0
  112. wolensing-0.0.1/wolensing/lensmodels/hessian.py +56 -0
  113. wolensing-0.0.1/wolensing/lensmodels/lens.py +143 -0
  114. wolensing-0.0.1/wolensing/lensmodels/ok.ipynb +256 -0
  115. wolensing-0.0.1/wolensing/lensmodels/potential.py +47 -0
  116. wolensing-0.0.1/wolensing/plot/.ipynb_checkpoints/plot-checkpoint.py +50 -0
  117. wolensing-0.0.1/wolensing/plot/__init__.py +0 -0
  118. wolensing-0.0.1/wolensing/plot/plot.py +50 -0
  119. wolensing-0.0.1/wolensing/utils/.ipynb_checkpoints/utils-checkpoint.py +154 -0
  120. wolensing-0.0.1/wolensing/utils/__init__.py +0 -0
  121. wolensing-0.0.1/wolensing/utils/histogram.py +123 -0
  122. wolensing-0.0.1/wolensing/utils/utils.py +149 -0
@@ -0,0 +1,39 @@
1
+ # This workflow will upload a Python Package using Twine when a release is created
2
+ # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3
+
4
+ # This workflow uses actions that are not certified by GitHub.
5
+ # They are provided by a third-party and are governed by
6
+ # separate terms of service, privacy policy, and support
7
+ # documentation.
8
+
9
+ name: Pytest
10
+
11
+ on:
12
+ pull_request:
13
+ branches: [main]
14
+
15
+ permissions:
16
+ contents: write
17
+
18
+ jobs:
19
+ build:
20
+
21
+ runs-on: ubuntu-latest
22
+ strategy:
23
+ matrix:
24
+ python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
25
+
26
+ steps:
27
+ - uses: actions/checkout@v4
28
+ - name: Set up Python ${{ matrix.python-version }}
29
+ uses: actions/setup-python@v4
30
+ with:
31
+ python-version: ${{ matrix.python-version }}
32
+ - uses: actions/checkout@v4
33
+ - name: Install dependencies
34
+ run: |
35
+ python -m pip install --upgrade pip
36
+ pip install pytest
37
+ - name: Test with pytest
38
+ run: |
39
+ pytest
@@ -0,0 +1,73 @@
1
+ # This workflow will upload a Python Package using Twine when a release is created
2
+ # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3
+
4
+ # This workflow uses actions that are not certified by GitHub.
5
+ # They are provided by a third-party and are governed by
6
+ # separate terms of service, privacy policy, and support
7
+ # documentation.
8
+
9
+ name: Test build
10
+
11
+ on:
12
+ push:
13
+ branches: [dev]
14
+
15
+ permissions:
16
+ contents: write
17
+
18
+ jobs:
19
+ build:
20
+
21
+ runs-on: ubuntu-latest
22
+ strategy:
23
+ matrix:
24
+ python-version: ["3.11"]
25
+
26
+ steps:
27
+ - uses: actions/checkout@v4
28
+ - name: Set up Python ${{ matrix.python-version }}
29
+ uses: actions/setup-python@v4
30
+ with:
31
+ python-version: ${{ matrix.python-version }}
32
+ - uses: actions/checkout@v4
33
+ - name: Dynamic versioning with date and time
34
+ run: |
35
+ git config user.name github-actions
36
+ git config user.email github-actions@github.com
37
+ VERSION=$(date +"%Y.%m.%d.%H%M")
38
+ echo "__version__ = \"$VERSION\"" > wolensing/__about__.py
39
+ git add wolensing/__about__.py
40
+ git commit -m "Dynamic versioning: $VERSION"
41
+ git tag $VERSION
42
+ git push
43
+ git push --tags
44
+
45
+ - name: Install latex
46
+ run: |
47
+ sudo apt install texlive-fonts-recommended texlive-fonts-extra
48
+ sudo apt install dvipng cm-super
49
+ - name: Install lensinggw
50
+ run: |
51
+ git clone https://gitlab.com/gpagano/lensinggw.git
52
+ cd lensinggw/
53
+ python setup.py install
54
+ cd ../
55
+ - name: Install dependencies
56
+ run: |
57
+ python -m pip install --upgrade pip
58
+ pip install -r requirements.txt
59
+ python -m pip install --upgrade build twine pytest numba
60
+ pip install .
61
+ - name: Test with pytest
62
+ run: |
63
+ cd test/
64
+ python3 -m pytest
65
+ - name: Build and upload to PyPI
66
+ if: ${{ matrix.python-version == '3.11'}}
67
+ run: |
68
+ python -m build
69
+ python -m twine upload --repository testpypi dist/*
70
+ env:
71
+ TWINE_USERNAME: __token__
72
+ TWINE_PASSWORD: ${{ secrets.TWINE_TEST_TOKEN }}
73
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -0,0 +1,9 @@
1
+ __pycache__
2
+ *.un~
3
+ *.swp
4
+ data/
5
+ examples/SimonWorking&NotWorking_example_type2(1).ipynb
6
+ examples/data/
7
+ examples/*.txt
8
+ */.ipynb_checkpoints
9
+ examples/*.pdf
@@ -0,0 +1,6 @@
1
+ {
2
+ "cells": [],
3
+ "metadata": {},
4
+ "nbformat": 4,
5
+ "nbformat_minor": 5
6
+ }
@@ -0,0 +1,2 @@
1
+ # Created by pytest automatically.
2
+ *
@@ -0,0 +1,4 @@
1
+ Signature: 8a477f597d28d172789f06886806bc55
2
+ # This file is a cache directory tag created by pytest.
3
+ # For information about cache directory tags, see:
4
+ # https://bford.info/cachedir/spec.html
@@ -0,0 +1,8 @@
1
+ # pytest cache directory #
2
+
3
+ This directory contains data from the pytest's cache plugin,
4
+ which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
5
+
6
+ **Do not** commit this to version control.
7
+
8
+ See [the docs](https://docs.pytest.org/en/stable/how-to/cache.html) for more information.
@@ -0,0 +1,8 @@
1
+ [
2
+ "test/amplification_factor_test.py::test_freq_amp",
3
+ "test/amplification_factor_test.py::test_integrator_cpu",
4
+ "test/amplification_factor_test.py::test_integrator_gpu",
5
+ "test/amplification_factor_test.py::test_plot_freq_abs",
6
+ "test/amplification_factor_test.py::test_plot_freq_pha",
7
+ "test/amplification_factor_test.py::test_plot_time"
8
+ ]
@@ -0,0 +1 @@
1
+ []
@@ -0,0 +1,64 @@
1
+ # Read the Docs configuration file for Sphinx projects
2
+
3
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
+
5
+
6
+ # Required
7
+
8
+ version: 2
9
+
10
+
11
+ # Set the OS, Python version and other tools you might need
12
+
13
+ build:
14
+
15
+ os: ubuntu-22.04
16
+
17
+ tools:
18
+
19
+ python: "3.12"
20
+
21
+ # You can also specify other tool versions:
22
+
23
+ # nodejs: "20"
24
+
25
+ # rust: "1.70"
26
+
27
+ # golang: "1.20"
28
+
29
+
30
+ # Build documentation in the "docs/" directory with Sphinx
31
+
32
+ sphinx:
33
+
34
+ configuration: docs/conf.py
35
+
36
+ # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
37
+
38
+ # builder: "dirhtml"
39
+
40
+ # Fail on all warnings to avoid broken references
41
+
42
+ # fail_on_warning: true
43
+
44
+
45
+ # Optionally build your docs in additional formats such as PDF and ePub
46
+
47
+ # formats:
48
+
49
+ # - pdf
50
+
51
+ # - epub
52
+
53
+
54
+ # Optional but recommended, declare the Python requirements required
55
+
56
+ # to build your documentation
57
+
58
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
59
+
60
+ # python:
61
+
62
+ # install:
63
+
64
+ # - requirements: docs/requirements.txt
@@ -0,0 +1,7 @@
1
+ cff-version: 1.2.0
2
+ message: "If you use this software, please cite it as below."
3
+ authors:
4
+ - family-names: Yeung
5
+ given-names: Simon, Man Chun
6
+ title: "wolensing"
7
+ version: 1.0.0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022, wolensing developers
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,60 @@
1
+ Metadata-Version: 2.1
2
+ Name: wolensing
3
+ Version: 0.0.1
4
+ Summary: A package for computing wave optics amplification factor.
5
+ Project-URL: Homepage, https://github.com/manchunyeung/wolensing
6
+ Author-email: "Simon Man-Chun Yeung, Mark Ho-Yeuk Cheung" <yeungm@uwm.edu>
7
+ Classifier: License :: OSI Approved :: MIT License
8
+ Classifier: Operating System :: OS Independent
9
+ Classifier: Programming Language :: Python :: 3.10
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Requires-Python: <3.12,>=3.6
13
+ Requires-Dist: fast-histogram
14
+ Requires-Dist: jax
15
+ Requires-Dist: jaxlib
16
+ Requires-Dist: lenstronomy
17
+ Requires-Dist: matplotlib
18
+ Requires-Dist: numpy>=1.18.1
19
+ Requires-Dist: pycbc
20
+ Requires-Dist: scipy>1.4.1
21
+ Requires-Dist: tqdm
22
+ Description-Content-Type: text/x-rst
23
+
24
+
25
+ .. image:: https://github.com/manchunyeung/wolensing/actions/workflows/pytest.yaml/badge.svg
26
+ :target: https://github.com/manchunyeung/wolensing/actions/workflows/pytest.yaml
27
+
28
+ .. image:: https://img.shields.io/badge/license-MIT-blue.svg
29
+ :target: https://github.com/mhycheung/jaxqualin/blob/main/LICENSE
30
+
31
+ .. image:: https://badgen.net/badge/Read/the doc/blue
32
+ :target: https://manchunyeung.github.io/wolensing/
33
+
34
+ wolensing
35
+ =========
36
+
37
+ ``wolensing`` is a software package to simulate lensed gravitational waves. It computes the full wave optics amplification factor within the range of LIGO sensitivity and is compatible with arbitrary lens models. ``wolensing`` also supports jax to accelerate the computation.
38
+
39
+ Installation
40
+ ------------
41
+
42
+ First install ``lensingGW``::
43
+
44
+
45
+ git clone https://gitlab.com/gpagano/lensinggw.git
46
+ cd lensinggw
47
+ python setup.py install
48
+
49
+ ``wolensing`` can be installed with github or pip::
50
+
51
+ pip install wolensing
52
+
53
+
54
+ Examples Notebooks
55
+ -------------------
56
+
57
+ Examples notebooks showing the computation of wave optics amplification factor for different lens models and the plots of time delay contour are available at `https://github.com/manchunyeung/wolensing <https://github.com/manchunyeung/wolensing>`_
58
+
59
+
60
+
@@ -0,0 +1,37 @@
1
+
2
+ .. image:: https://github.com/manchunyeung/wolensing/actions/workflows/pytest.yaml/badge.svg
3
+ :target: https://github.com/manchunyeung/wolensing/actions/workflows/pytest.yaml
4
+
5
+ .. image:: https://img.shields.io/badge/license-MIT-blue.svg
6
+ :target: https://github.com/mhycheung/jaxqualin/blob/main/LICENSE
7
+
8
+ .. image:: https://badgen.net/badge/Read/the doc/blue
9
+ :target: https://manchunyeung.github.io/wolensing/
10
+
11
+ wolensing
12
+ =========
13
+
14
+ ``wolensing`` is a software package to simulate lensed gravitational waves. It computes the full wave optics amplification factor within the range of LIGO sensitivity and is compatible with arbitrary lens models. ``wolensing`` also supports jax to accelerate the computation.
15
+
16
+ Installation
17
+ ------------
18
+
19
+ First install ``lensingGW``::
20
+
21
+
22
+ git clone https://gitlab.com/gpagano/lensinggw.git
23
+ cd lensinggw
24
+ python setup.py install
25
+
26
+ ``wolensing`` can be installed with github or pip::
27
+
28
+ pip install wolensing
29
+
30
+
31
+ Examples Notebooks
32
+ -------------------
33
+
34
+ Examples notebooks showing the computation of wave optics amplification factor for different lens models and the plots of time delay contour are available at `https://github.com/manchunyeung/wolensing <https://github.com/manchunyeung/wolensing>`_
35
+
36
+
37
+
@@ -0,0 +1,20 @@
1
+ # Minimal makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line, and also
5
+ # from the environment for the first two.
6
+ SPHINXOPTS ?=
7
+ SPHINXBUILD ?= sphinx-build
8
+ SOURCEDIR = source
9
+ BUILDDIR = build
10
+
11
+ # Put it first so that "make" without argument is like "make help".
12
+ help:
13
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14
+
15
+ .PHONY: help Makefile
16
+
17
+ # Catch-all target: route all unknown targets to Sphinx using the new
18
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19
+ %: Makefile
20
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -0,0 +1,4 @@
1
+ # Sphinx build info version 1
2
+ # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3
+ config: c7e82d02b86b8530728488370f726958
4
+ tags: 645f666f9bcd5a90fca523b33c5a78b7