-
Notifications
You must be signed in to change notification settings - Fork 53
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
base: main
Are you sure you want to change the base?
Conversation
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. |
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. |
The links I tried are working, is this good for review? |
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? |
@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. |
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