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 autolink to docs #76

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Add autolink to docs #76

wants to merge 8 commits into from

Conversation

ewu63
Copy link
Collaborator

@ewu63 ewu63 commented Apr 10, 2022

Purpose

This PR adds the extension sphinx-codeautolink which creates links automatically to our API docs. Will keep this as draft as I debug the process.

Expected time until merged

A few days once I get everything sorted.

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

@ewu63
Copy link
Collaborator Author

ewu63 commented Aug 9, 2022

Alright I've no idea what's going on, the links now work locally (for pygeo at least) but the PR docs build does not. Maybe @sseraj you can try to see if you're able to reproduce the issue.

@ewu63
Copy link
Collaborator Author

ewu63 commented Aug 12, 2022

So I spent some time looking into this further, and the build works locally because pygeo is installed into the same python environment (the docs do not have to be built for pygeo for the links to work). Somehow that makes this stuff work, which means the current setup is still messed up. I suspect further path issues in autodoc.

@marcomangano
Copy link
Contributor

The links I tried are working, is this good for review?

@eirikurj
Copy link
Contributor

eirikurj commented Mar 26, 2024

I dont think this is working as it should. There are at least loads of warnings during the RTD/sphinx build. What links did you test?

@marcomangano
Copy link
Contributor

@eirikurj I did not look at the log, but I tested a few crosslinks top other RTD pages (e.g. pyoptsparse) and they worked. I think I am misunderstanding the goal of the PR though.

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.

3 participants