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

add issue and PR directives for sphinx #658

Merged
merged 4 commits into from
Nov 25, 2021

Conversation

CagtayFabry
Copy link
Member

@CagtayFabry CagtayFabry commented Nov 24, 2021

format as seen in the xarray docs but we can adopt to a different style, I like the idea though

result: https://weldx--658.org.readthedocs.build/en/658/changelog_link.html

Changes

  • links issues/PRs in sphinx with specific code directive

Checks

  • updated CHANGELOG.rst
  • updated doc/

@CagtayFabry CagtayFabry self-assigned this Nov 24, 2021
@CagtayFabry CagtayFabry added the documentation Improvements or additions to documentation label Nov 24, 2021
@codecov
Copy link

codecov bot commented Nov 24, 2021

Codecov Report

Merging #658 (7d16ffc) into master (79d7257) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #658   +/-   ##
=======================================
  Coverage   96.18%   96.18%           
=======================================
  Files          91       91           
  Lines        5867     5867           
=======================================
  Hits         5643     5643           
  Misses        224      224           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 79d7257...7d16ffc. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Nov 24, 2021

Unit Test Results

       1 files  ±0         1 suites  ±0   1m 55s ⏱️ +9s
1 936 tests ±0  1 936 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit 7d16ffc. ± Comparison against base commit 79d7257.

♻️ This comment has been updated with latest results.

@CagtayFabry CagtayFabry marked this pull request as ready for review November 24, 2021 11:42
@CagtayFabry
Copy link
Member Author

let me know what you think of this format @vhirtham @marscher 🚀

@vhirtham
Copy link
Collaborator

let me know what you think of this format @vhirtham @marscher 🚀

This is really nice 👌 . Couldn't remember the rst link syntax and c&p'd them every time. This one is rather easy to memorize. 😉

Copy link
Contributor

@marscher marscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That one will make our lives easier (will now write changelog entries like crazy) :)

Thank you!

@CagtayFabry
Copy link
Member Author

That one will make our lives easier (will now write changelog entries like crazy) :)

Thank you!

sadly rstfmt doesn't work with this because it doesn't know the directive
oh well, it was fun while it lasted 🤷‍♂️

(you can go back to 2 spaces now as well)

@CagtayFabry CagtayFabry merged commit e3d269b into BAMWelDX:master Nov 25, 2021
@CagtayFabry CagtayFabry deleted the update_changelog_links branch November 25, 2021 11:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants