Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation #69

Merged
merged 43 commits into from
Nov 8, 2022
Merged

Improve Documentation #69

merged 43 commits into from
Nov 8, 2022

Conversation

tornede
Copy link
Owner

@tornede tornede commented Nov 8, 2022

Improve Documentation

  • Add documentation using Sphinx, therefore a workflow is created to build and push the website
  • The build documentation will be pushed to a separate branch gh-pages

Update code documentation of PyExperimenter (#65)

  • The API of the class PyExperimenter has been updated and documented

Convert project to pyproject.toml using Poetry (#54)

  • Create pyproject.toml via Poetry
  • Add all dependencies for PyExperimenter itself as well as for the development
  • Update the installation description within documentation of PyExperimenter
  • Update How-to-Contribute documentation to cover Poetry
  • Update development workflow of How-to-Contribute documentation to cover all necessary steps

Add workflow to automatically check tests (#55)

  • Adds a simple test runner using GitHub Actions.
  • Uses poetry to install the package and locked dependencies.
  • Caching the virtual environment. This prevents having to install it every time and cuts down on CI roundtrip times.
  • It tests a matrix of various python versions (3.7, 3.8, 3.9) and OS versions (Ubuntu, MacOS, Windows). Python 3.10 is excluded for now, since installing some of the dependencies takes a very long time.

tornede and others added 12 commits October 19, 2022 13:47
* Create pyproject.toml via Poetry
* Add all dependencies for PyExperimenter itself as well as for the development
* Update the installation description within documentation of PyExperimenter
* Update How-to-Contribute documentation to cover Poetry
* Update development workflow of How-to-Contribute documentation to cover all necessary steps

Co-authored-by: Tanja Tornede <[email protected]>
Co-authored-by: Alexander Tornede <[email protected]>
Adds a simple test runner using GitHub Actions. 
* Uses poetry to install the package and locked dependencies.
* Caching the virtual environment. This prevents having to install it every time and cuts down on CI roundtrip times.
* It tests a matrix of various python versions (3.7, 3.8, 3.9) and OS versions (Ubuntu, MacOS, Windows). Python 3.10 is excluded for now, since installing some of the dependencies takes a very long time.
@tornede tornede merged commit 2dc16c0 into develop Nov 8, 2022
@tornede tornede deleted the docs branch November 8, 2022 16:19
tornede added a commit that referenced this pull request Nov 8, 2022
Improve Documentation

* Add documentation using Sphinx, therefore a workflow is created to build and push the website
* The build documentation will be pushed to a separate branch `gh-pages` 

Update code documentation of PyExperimenter ([#65](#65))

* The API of the class PyExperimenter has been updated and documented

Convert project to pyproject.toml using Poetry ([#54](#54))

* Create pyproject.toml via Poetry
* Add all dependencies for PyExperimenter itself as well as for the development
* Update the installation description within documentation of PyExperimenter
* Update How-to-Contribute documentation to cover Poetry
* Update development workflow of How-to-Contribute documentation to cover all necessary steps

Add workflow to automatically check tests ([#55](#55))

* Adds a simple test runner using GitHub Actions. 
* Uses poetry to install the package and locked dependencies.
* Caching the virtual environment. This prevents having to install it every time and cuts down on CI roundtrip times.
* It tests a matrix of various python versions (3.7, 3.8, 3.9) and OS versions (Ubuntu, MacOS, Windows). Python 3.10 is excluded for now, since installing some of the dependencies takes a very long time.

Co-authored-by: Helena Graf <[email protected]>
Co-authored-by: Karlson Pfannschmidt <[email protected]>
Co-authored-by: Alexander Tornede <[email protected]>
tornede added a commit that referenced this pull request Nov 8, 2022
Improve Documentation

* Add documentation using Sphinx, therefore a workflow is created to build and push the website
* The build documentation will be pushed to a separate branch `gh-pages` 

Update code documentation of PyExperimenter ([#65](#65))

* The API of the class PyExperimenter has been updated and documented

Convert project to pyproject.toml using Poetry ([#54](#54))

* Create pyproject.toml via Poetry
* Add all dependencies for PyExperimenter itself as well as for the development
* Update the installation description within documentation of PyExperimenter
* Update How-to-Contribute documentation to cover Poetry
* Update development workflow of How-to-Contribute documentation to cover all necessary steps

Add workflow to automatically check tests ([#55](#55))

* Adds a simple test runner using GitHub Actions. 
* Uses poetry to install the package and locked dependencies.
* Caching the virtual environment. This prevents having to install it every time and cuts down on CI roundtrip times.
* It tests a matrix of various python versions (3.7, 3.8, 3.9) and OS versions (Ubuntu, MacOS, Windows). Python 3.10 is excluded for now, since installing some of the dependencies takes a very long time.

Co-authored-by: Helena Graf <[email protected]>
Co-authored-by: Karlson Pfannschmidt <[email protected]>
Co-authored-by: Alexander Tornede <[email protected]>
tornede added a commit that referenced this pull request Nov 8, 2022
commit 2dc16c0
Author: tornede <[email protected]>
Date:   Tue Nov 8 17:18:56 2022 +0100

    Improve Documentation (#69)

    Improve Documentation

    * Add documentation using Sphinx, therefore a workflow is created to build and push the website
    * The build documentation will be pushed to a separate branch `gh-pages`

    Update code documentation of PyExperimenter ([#65](#65))

    * The API of the class PyExperimenter has been updated and documented

    Convert project to pyproject.toml using Poetry ([#54](#54))

    * Create pyproject.toml via Poetry
    * Add all dependencies for PyExperimenter itself as well as for the development
    * Update the installation description within documentation of PyExperimenter
    * Update How-to-Contribute documentation to cover Poetry
    * Update development workflow of How-to-Contribute documentation to cover all necessary steps

    Add workflow to automatically check tests ([#55](#55))

    * Adds a simple test runner using GitHub Actions.
    * Uses poetry to install the package and locked dependencies.
    * Caching the virtual environment. This prevents having to install it every time and cuts down on CI roundtrip times.
    * It tests a matrix of various python versions (3.7, 3.8, 3.9) and OS versions (Ubuntu, MacOS, Windows). Python 3.10 is excluded for now, since installing some of the dependencies takes a very long time.

    Co-authored-by: Helena Graf <[email protected]>
    Co-authored-by: Karlson Pfannschmidt <[email protected]>
    Co-authored-by: Alexander Tornede <[email protected]>

commit 9c3f505
Author: tornede <[email protected]>
Date:   Mon Oct 31 14:40:11 2022 +0100

    Bugfix of wrong column order when writing to DB (#62)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants