MACH-Aero icon indicating copy to clipboard operation
MACH-Aero copied to clipboard

Published 20 hours ago • verified publisher icon mdolab

Add autolink to docs

Open ewu63 opened this issue 2 years ago • 5 comments

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)
  • [x] Documentation update
  • [ ] Maintenance update
  • [ ] Other (please describe)

ewu63 avatar Apr 10 '22 16:04 ewu63

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 avatar Aug 09 '22 23:08 ewu63

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.

ewu63 avatar Aug 12 '22 16:08 ewu63

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

marcomangano avatar Mar 26 '24 13:03 marcomangano

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 avatar Mar 26 '24 16:03 eirikurj

@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.

marcomangano avatar Mar 26 '24 19:03 marcomangano