mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-07-31 02:13:39 +02:00
Dev/automate documentation build (#1357)
* some test about building docs * indendation error * typo - * forgot to get package hdf5 * had to add shinx and doxygen as well * oke created environmnet file * typo * dont use conda * dont use conda * cannot upload artefact commit to gh-pages * correct copy * mmh * try with tokem * set write permisison * script to update main_index for versioned documentation * rename main_index to index * use absolute path in python script * update main_index upon a release * extract release type from version * copy release notes * updated links from devdoc to slsDetectorPackage, handling .md for new versions * changed page source * updated documentation link in README * add guideline for Package Versioning to documentation also used as a test * typo in workflow * why didnt it copy? * copied from build instead of docs * change back - trigger for push * only trigger for pull_requests and releases * removed conda environment file * automatically update documentation paths in release notes * only keep templated README.md * added README and updated links * update Release notes template manually * generate release notes script not needed anymore * modified readme to reflect dependencies insides build from source * subheadings in dependencies --------- Co-authored-by: Dhanya Thattil <dhanya.thattil@psi.ch>
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
Package Versioning
|
||||
===================
|
||||
|
||||
We use Semantic Versioning for our releases. Each version number is in the format MAJOR.MINOR.PATCH, where:
|
||||
|
||||
- **MAJOR** version increments indicate incompatible API changes,
|
||||
- **MINOR** version increments indicate added functionality in a backward-compatible manner,
|
||||
- **PATCH** version increments indicate backward-compatible bug fixes.
|
||||
|
||||
@@ -66,6 +66,7 @@ slsDetectorPackage
|
||||
container_utils
|
||||
type_traits
|
||||
ToString
|
||||
Versioning
|
||||
Testing
|
||||
|
||||
.. toctree::
|
||||
|
||||
Reference in New Issue
Block a user