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.

Sign up for GitHub

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

Jump to bottom

[#1375] add versioning to python docs #1397

Merged
merged 4 commits into from
Mar 10, 2023
Merged

[#1375] add versioning to python docs #1397

merged 4 commits into from
Mar 10, 2023

Conversation

bossenti
Copy link
Contributor

@bossenti bossenti commented Mar 7, 2023 •
edited

Purpose

This PR introduces versioning for the Python documentation.
This includes the following adaptions:

  • use make as versioning provider
  • adapt Python doc publishing workflow to make use of mike
  • include publishing of docs in Python deployment workflow

Remarks

PR introduces (a) breaking change(s): no

PR introduces (a) deprecation(s): no

@bossenti bossenti requested a review from SvenO3 March 7, 2023 21:08
@bossenti bossenti linked an issue Mar 7, 2023 that may be closed by this pull request
Versioning for Python docs #1375
Closed
@github-actions github-actions bot added dependencies Pull requests that update a dependency file gh-actions Pull requests that update GitHub Actions code python Pull requests that update Python code labels Mar 7, 2023
@bossenti bossenti added the documentation Everything related to documentation label Mar 7, 2023
@github-actions github-actions bot removed the documentation Everything related to documentation label Mar 8, 2023
@bossenti bossenti force-pushed the 1375-versioning-for-python-docs branch from 2c47c01 to de18901 Compare March 8, 2023 21:42
@bossenti bossenti merged commit c530d55 into dev Mar 10, 2023
@bossenti bossenti deleted the 1375-versioning-for-python-docs branch March 10, 2023 19:35
bossenti added a commit that referenced this pull request Mar 10, 2023
@bossenti
[#1375] add versioning to python docs (#1397)
9070160 
* add mike as versioning provider for python docs (#1375)

Signed-off-by: bossenti <bossenti@posteo.de>

* adapt GitHub workflow for python docs creation (#1375)

* add doc releasing to python deployment (#1375)

* retrieve release version from branch name (#1375)

---------

Signed-off-by: bossenti <bossenti@posteo.de>

[#1375] add versioning to python docs (#1397)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tenthe tenthe tenthe approved these changes

@SvenO3 SvenO3 SvenO3 approved these changes

Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file gh-actions Pull requests that update GitHub Actions code python Pull requests that update Python code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Versioning for Python docs
3 participants
@bossenti @tenthe @SvenO3