Addition of documenttaion pages #16
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* updated example dir and notebook * Update example1.ipynb * Changed GoogleColab link
* UPdated Sphinx documentation New Index.rst page, Old index.rst page became corese.rst. Added new pages: python_api/api_root.rst with autogenerated API doc. Added python_api/bridges.rst page The example1.ipynb notebook is rendered as a uset_guide. INSTALL.md is rendered as an installation page * Update pyproject.toml
Added the installation of the packages from the docs/requirements.txt in case a new extension is added.
This reverts commit 9324b1a.
* Updated Sphinx documentation New Index.rst page, Old index.rst page became corese.rst. Added new pages: python_api/api_root.rst with autogenerated API doc. Added python_api/bridges.rst page The example1.ipynb notebook is rendered as a uset_guide. INSTALL.md is rendered as an installation page * Updated pyproject.toml * Moved VIESION.txt to src/pycorese to update the version only in one place. * Minor fixes and updates
AnnaBobasheva
added a commit
that referenced
this pull request
Jan 3, 2025
* Addition of documenttaion pages (#16) * Updated Sphinx documentation New Index.rst page, Old index.rst page became corese.rst. Added new pages: python_api/api_root.rst with autogenerated API doc. Added python_api/bridges.rst page The example1.ipynb notebook is rendered as a uset_guide. INSTALL.md is rendered as an installation page * Added the installation of the packages from the docs/requirements.txt in case a new extension is added. * Moved VIESION.txt to src/pycorese to update the version only in one place. * Minor fixes and updates * Update pypi.yml Added verbosity to the twine command * Update pyproject.toml Had to add the content type for README.md, otherwise it didn't render correctly on Pypi. * Update pypi.yml Removed the verbosity from the twine command. * Revert "Update pypi.yml" This reverts commit 77c6597. * Revert "Update pypi.yml" This reverts commit ebde89c. * Revert "Update pyproject.toml" This reverts commit 00e3c76. * Squashed commit of the following: commit 6e1dfec Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Mon Dec 23 18:17:12 2024 +0100 Update pyproject.toml readme = { file = "README.md", content-type = "text/markdown" } commit 32eafa3 Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Mon Dec 23 16:38:37 2024 +0100 Revert "Merge branch 'main' into develop" This reverts commit 85d2fd0, reversing changes made to 13ab5bc. commit 85d2fd0 Merge: 13ab5bc 4f73eca Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Mon Dec 23 16:28:40 2024 +0100 Merge branch 'main' into develop commit 13ab5bc Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Mon Dec 23 15:22:45 2024 +0100 Feature/update docs (#15) * Updated Sphinx documentation New Index.rst page, Old index.rst page became corese.rst. Added new pages: python_api/api_root.rst with autogenerated API doc. Added python_api/bridges.rst page The example1.ipynb notebook is rendered as a uset_guide. INSTALL.md is rendered as an installation page * Updated pyproject.toml * Moved VIESION.txt to src/pycorese to update the version only in one place. * Minor fixes and updates commit 203b617 Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Tue Dec 17 10:34:59 2024 +0100 Revert "Update sphinx-dev.yml" This reverts commit 9324b1a. commit 9324b1a Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Tue Dec 17 10:27:17 2024 +0100 Update sphinx-dev.yml Added the installation of the packages from the docs/requirements.txt in case a new extension is added. commit 8094112 Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Mon Dec 16 11:36:03 2024 +0100 Update requirements.txt commit 771db55 Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Mon Dec 16 11:32:04 2024 +0100 Updated Sphinx documentation (#14) * UPdated Sphinx documentation New Index.rst page, Old index.rst page became corese.rst. Added new pages: python_api/api_root.rst with autogenerated API doc. Added python_api/bridges.rst page The example1.ipynb notebook is rendered as a uset_guide. INSTALL.md is rendered as an installation page * Update pyproject.toml commit a373b1e Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Fri Dec 6 17:46:59 2024 +0100 Update INSTALL.md commit d922cd3 Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Fri Dec 6 17:31:07 2024 +0100 Updated README files, dependencies, and downgraded version (#12) commit 78be7a7 Author: Anna Bobasheva <33026767+AnnaBobasheva@users.noreply.github.com> Date: Tue Dec 3 18:48:09 2024 +0100 Feature/add example notebook (#11) * updated example dir and notebook * Update example1.ipynb * Changed GoogleColab link commit 466eab9 Author: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr> Date: Tue Nov 5 14:31:48 2024 +0100 call CoreseInfo.getVersion() instead of returning a static sting commit 5376a84 Author: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr> Date: Tue Nov 5 14:30:39 2024 +0100 maven-artifact python package not necessary commit 041342d Author: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr> Date: Tue Nov 5 14:30:17 2024 +0100 typo commit e3601c8 Merge: e27d995 9adb0b2 Author: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr> Date: Mon Nov 4 14:40:28 2024 +0100 Merge branch 'main' into develop commit e27d995 Merge: 1eb7e43 be337dd Author: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr> Date: Mon Nov 4 14:22:51 2024 +0100 Merge branch 'main' into develop commit 1eb7e43 Merge: 7cda584 5d62426 Author: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr> Date: Mon Nov 4 14:21:34 2024 +0100 Merge branch 'release/v1.0.1' into develop * Synch "develop" and "main" to re0run Sphinx pages creation (#17) * typo * maven-artifact python package not necessary * call CoreseInfo.getVersion() instead of returning a static sting * Feature/add example notebook (#11) * updated example dir and notebook * Update example1.ipynb * Changed GoogleColab link * Updated README files, dependencies, and downgraded version (#12) * Update INSTALL.md * Updated Sphinx documentation (#14) * UPdated Sphinx documentation New Index.rst page, Old index.rst page became corese.rst. Added new pages: python_api/api_root.rst with autogenerated API doc. Added python_api/bridges.rst page The example1.ipynb notebook is rendered as a uset_guide. INSTALL.md is rendered as an installation page * Update pyproject.toml * Update requirements.txt * Update sphinx-dev.yml Added the installation of the packages from the docs/requirements.txt in case a new extension is added. * Revert "Update sphinx-dev.yml" This reverts commit 9324b1a. * Feature/update docs (#15) * Updated Sphinx documentation New Index.rst page, Old index.rst page became corese.rst. Added new pages: python_api/api_root.rst with autogenerated API doc. Added python_api/bridges.rst page The example1.ipynb notebook is rendered as a uset_guide. INSTALL.md is rendered as an installation page * Updated pyproject.toml * Moved VIESION.txt to src/pycorese to update the version only in one place. * Minor fixes and updates * Revert "Merge branch 'main' into develop" This reverts commit 85d2fd0, reversing changes made to 13ab5bc. * Update pyproject.toml readme = { file = "README.md", content-type = "text/markdown" } --------- Co-authored-by: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr> --------- Co-authored-by: Jean Luc Szpyrka <Jean-Luc.Szpyrka@inria.fr>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.