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

docs: switch to intersphinx links #215

Merged
merged 1 commit into from
Feb 17, 2021
Merged

docs: switch to intersphinx links #215

merged 1 commit into from
Feb 17, 2021

Conversation

redeboer
Copy link
Member

@redeboer redeboer commented Feb 17, 2021

Spin-off from #203

This makes the notebooks a bit easier to maintain (especially when there are interface changes) and results in nicer formatting:
image

where for instance optimize() is generated with {meth}`.Minuit2.optimize`.

The drawback is that the notebooks don't look as nice anymore:
image

@redeboer redeboer added 📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience labels Feb 17, 2021
@redeboer redeboer self-assigned this Feb 17, 2021
@codecov
Copy link

codecov bot commented Feb 17, 2021

Codecov Report

Merging #215 (4684154) into master (31d5bfd) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #215   +/-   ##
=======================================
  Coverage   81.10%   81.10%           
=======================================
  Files          13       13           
  Lines         725      725           
  Branches       99       99           
=======================================
  Hits          588      588           
  Misses        106      106           
  Partials       31       31           
Flag Coverage Δ
unittests 81.10% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@redeboer redeboer merged commit 1cd8a0a into master Feb 17, 2021
@redeboer redeboer deleted the intersphinx-syntax branch February 17, 2021 12:54
@redeboer redeboer added this to the 0.1.4 milestone Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant