From 65c891b3c4c8617463a33922081c72689d165ecd Mon Sep 17 00:00:00 2001 From: Thomas Grandits Date: Thu, 27 Jan 2022 18:07:37 +0100 Subject: [PATCH] ReadTheDocs update --- .readthedocs.yaml | 14 ++++++++++++++ README.md | 17 ----------------- docs/index.rst | 20 -------------------- setup.py | 2 +- 4 files changed, 15 insertions(+), 38 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3a3e441 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,14 @@ +# .readthedocs.yaml + +build: + image: latest + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +python: + version: 3.8 + pip_install: true + extra_requirements: + - docs \ No newline at end of file diff --git a/README.md b/README.md index 21a2127..29089d9 100644 --- a/README.md +++ b/README.md @@ -49,20 +49,3 @@ You should see the recorded map of the [OpenEP](https://openep.io) example, toge [https://cartoreader-lite.readthedocs.io/en/latest](https://cartoreader-lite.readthedocs.io/en/latest) -# Citation - -If you use the library in your scientific projects, please cite the associated Zenodo archive: https://www.zenodo.org. - -```bibtex -%TODO: FIM -@software{thomas_grandits_2021_5594452, - author = {Thomas Grandits}, - title = {A Fast Iterative Method Python package}, - month = oct, - year = 2021, - publisher = {Zenodo}, - version = {1.1}, - doi = {10.5281/zenodo.5594452}, - url = {https://doi.org/10.5281/zenodo.5594452} -} -``` diff --git a/docs/index.rst b/docs/index.rst index 1bd84ea..d19b1b4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,26 +40,6 @@ Usage .. include:: example.inc -Citation ------------- - -If you use the library in your scientific projects, please cite the associated `Zenodo archive `_. - -.. code-block:: bibtex - - %TODO - @software{thomas_grandits_2021_5594452, - author = {Thomas Grandits}, - title = {A Fast Iterative Method Python package}, - month = oct, - year = 2021, - publisher = {Zenodo}, - version = {1.1}, - doi = {10.5281/zenodo.5594452}, - url = {https://doi.org/10.5281/zenodo.5594452} - } - - Detailed Content ----------------- .. toctree:: diff --git a/setup.py b/setup.py index a720e12..af42771 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ long_description=long_description, long_description_content_type="text/markdown", url="https://github.com/thomgrand/cartoreader-lite", - packages=["cartoreader_lite", "cartoreader_lite.high_level", "cartoreader_lite.low_level"], + packages=["cartoreader_lite", "cartoreader_lite.high_level", "cartoreader_lite.low_level", "cartoreader_lite.postprocessing"], install_requires=["numpy", "pyvista>=0.33", "vtk", "pandas", "scipy", "trimesh", "rtree"], #Geometric postprocessing classifiers=[