Skip to content

Add pre-commit check for sphinx cross-references #5317

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
Closed
OriolAbril opened this issue Jan 7, 2022 · 3 comments · Fixed by #5486
Closed

Add pre-commit check for sphinx cross-references #5317

OriolAbril opened this issue Jan 7, 2022 · 3 comments · Fixed by #5486
Assignees
@symeneses
Labels
beginner friendly docs pre-commit

Comments

@OriolAbril
Copy link
Member

Now that we have versioned docs, we can't use urls for internal links if we want each version to point to themselves. I think we should add a pre-commit check to ensure there are no links pointing to docs.pymc.io anywhere inside the docs/source/ folder.

I don't know pre-commit but it seems like this should be easy for someone who does know their way around it. cc @MarcoGorelli if you agree with this, can you label it beginner friendly?
@MarcoGorelli
Copy link
Contributor

yeah I think just a pygrep check for this would be good

@OriolAbril OriolAbril removed the sphinx label Jan 27, 2022
@symeneses
Copy link
Contributor

Hi, I would like to work on this issue ✋🏽

@OriolAbril
Copy link
Member Author

Assigned it to you

symeneses added a commit to symeneses/pymc that referenced this issue Feb 18, 2022
@symeneses
🔧 Add check for docs cross-references pymc-devs#5317
ac05c9c
@symeneses symeneses mentioned this issue Feb 18, 2022
Merged
13 tasks
symeneses added a commit to symeneses/pymc that referenced this issue Feb 18, 2022
@symeneses
✨ check jupyter notebooks pymc-devs#5317
74d9fd9
OriolAbril added a commit that referenced this issue Feb 22, 2022
@symeneses @OriolAbril
Add pre-commit check for docs cross-references (#5486)
114e439 
* 🔧 Add check for docs cross-references #5317

* ✨ check jupyter notebooks #5317

* 🔧 add all links in the intersphinx mapping

* 📝 add cross-references

* 📝 remove cross-references

* 📝 add cross-references

* 🔧 exclude files

* Update .pre-commit-config.yaml

* 📝 add ignore file

Co-authored-by: Oriol Abril-Pla <[email protected]>

* ✏️ remove duplicated

* Fix ref in developer_guide.rst

Co-authored-by: Oriol Abril-Pla <[email protected]>

* Fix ref in developer_guide.rst

Co-authored-by: Oriol Abril-Pla <[email protected]>

* Fix reference in developer_guide.rst

Co-authored-by: Oriol Abril-Pla <[email protected]>

* Fix ref in examples.md

Co-authored-by: Oriol Abril-Pla <[email protected]>

* Fix ref in  learn/examples.md

Co-authored-by: Oriol Abril-Pla <[email protected]>

* Fix ref in learn/examples.md

Co-authored-by: Oriol Abril-Pla <[email protected]>

* Fix ref in learn/usage_overview.rst

Co-authored-by: Oriol Abril-Pla <[email protected]>

* 🙈 ignore index.md

* fix arviz cross references in notebooks

Co-authored-by: Oriol Abril-Pla <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@symeneses symeneses

Labels
beginner friendly docs pre-commit
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add pre-commit check for docs cross-references symeneses/pymc
5 participants
@michaelosthege @symeneses @OriolAbril @MarcoGorelli @mjhajharia