diff --git a/README.md b/README.md index 58d92a3f0d888b71ca87f3d302a27a877283dd27..e7c6c38a86a58c0a85b2521c55126b1a8c2fc868 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,7 @@ If you want to build plotID yourself, follow these steps: 1. Download the source code from [Gitlab](https://git.rwth-aachen.de/plotid/plotid_python): `git clone https://git.rwth-aachen.de/plotid/plotid_python.git` `cd plotid_python` -2. *[Optional]* Create a virtual environment (see [Installation](#Installation)). +2. *[Optional]* Create a virtual environment (see [Installation](#installation)). 3. *[Optional]* Run unittests and coverage: `python3 tests/runner_tests.py` 4. Build the package @@ -114,4 +114,4 @@ To install all optional dependencies use `pip install .[test,docs]` or `pip inst ## Documentation If you have more questions about plotID, please have a look at the [documentation](https://plotid.pages.rwth-aachen.de/plotid_python). -Also have a look at the [examples](./examples) that are shipped with plotID. +Also have a look at the [examples](https://git.rwth-aachen.de/plotid/plotid_python/-/tree/main/examples) that are shipped with plotID. diff --git a/docs/source/about.rst b/docs/source/about.rst index 5c7f2dc7c84e27892d303611c935e497386de9bb..6e46bf0e75a2e543fdb5bfe86f2211285412b70b 100644 --- a/docs/source/about.rst +++ b/docs/source/about.rst @@ -4,6 +4,6 @@ About plotID plotID is developed at the Institut Fluidsystemtechnik within nfdi4ing at the Technische Universität Darmstadt. Acknowledgements ---------------- +---------------- The authors would like to thank the Federal Government and the Heads of Government of the Länder, as well as the Joint Science Conference (GWK), for their funding and support within the framework of the NFDI4Ing consortium. Funded by the German Research Foundation (DFG) - project number 442146713. \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index dfec1e430ace2b700542e35042c0d1d4da97d67b..dbd16bdb547bea25b4eb461140b0e4f9f7a82a83 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -38,6 +38,8 @@ release = __version__ extensions = ["sphinx.ext.napoleon", "autoapi.extension", "myst_parser"] autoapi_type = "python" autoapi_dirs = ["../../plotid", "../../tests"] +# autoapi_keep_files = True +myst_heading_anchors = 2 # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/source/dependencies.rst b/docs/source/dependencies.rst index 7c5290c1d5a31957257be3e4339d7857ba232903..b9781f14d74a7fada93f15a8a849627ac448cb19 100644 --- a/docs/source/dependencies.rst +++ b/docs/source/dependencies.rst @@ -8,6 +8,7 @@ The plotID package depends on other software for its full funcionality. Since pl - `qrcode <https://github.com/lincolnloop/python-qrcode>`_: Creates QR codes from input data. qrcode is used to create the QR code which is printed on the plot in the end. - `numpy <https://numpy.org/doc/stable/>`_: Package for scientific computing. Right now it is only used to generate sample data in the examples. Since it is a dependency of matplotlib, it has to be installed anyway. + Optional dependencies that are not necessary to run plotID but more to contribute to the code quality are the following: - `coverage <https://coverage.readthedocs.io/en/6.5.0/#>`_: Program to measure the code coverage. It is used in the development of plotID to monitor the coverage of the code when the unit tests are run. diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index dd354c8698ea6d990ff1b421ad0822ef78a8bb65..0000000000000000000000000000000000000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -plotid -====== - -.. toctree:: - :maxdepth: 4 - - plotid diff --git a/docs/source/readme_link.md b/docs/source/readme_link.md new file mode 100644 index 0000000000000000000000000000000000000000..4bae9f3fd2d9f5dc887a61d6b0964f73c429c3d9 --- /dev/null +++ b/docs/source/readme_link.md @@ -0,0 +1,4 @@ +```{include} ../../README.md +:relative-docs: docs/ +:relative-images: +``` \ No newline at end of file diff --git a/docs/source/readme_link.rst b/docs/source/readme_link.rst deleted file mode 100644 index 648323f26365739c8c2b19a30ab2cb2b42eafd17..0000000000000000000000000000000000000000 --- a/docs/source/readme_link.rst +++ /dev/null @@ -1,8 +0,0 @@ -Overview -======== - -README file ------------ - -.. include:: ../../README.md - :parser: myst_parser.sphinx_ \ No newline at end of file diff --git a/docs/source/structure.rst b/docs/source/structure.rst index bef1bc936a5ea1273721f18010632d306f7ce504..932f3f41baccbcb2ffca3918e9652f3d4d459da9 100644 --- a/docs/source/structure.rst +++ b/docs/source/structure.rst @@ -1,5 +1,5 @@ Structure and architecture of plotID -================================== +==================================== A visualization of the internal structure of plotID is provided here. The structure tries to follow Object Oriented Programming (OOP) principles. First tagplot() is depicted with matplotlib as example plot engine: diff --git a/plotid/publish.py b/plotid/publish.py index b669644f4f5a0cc3e36ddb08740b49065a1645e7..428f3f94b49abb30f0333c186f0ca3e3b07025b2 100644 --- a/plotid/publish.py +++ b/plotid/publish.py @@ -245,7 +245,6 @@ def publish(figs_and_ids, src_datapath, dst_path, **kwargs): Path to data that should be published. dst_path : str Path to the destination directory. - **kwargs : dict, optional Extra arguments for additional publish options.