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

Implement automatic construction of restructured text references for data items in the objects file #25

Closed
bskinn opened this issue Nov 22, 2017 · 3 comments
Labels
issue: maybe 🤔 Being considered, but not certain type: enhancement ✨ Something to add
Milestone

Comments

@bskinn
Copy link
Owner

bskinn commented Nov 22, 2017

Restructured text references should follow a consistent format every time. Therefore, it should be possible to write a generator to produce those references for users to copy and paste into their source.

It seems like this would be particularly useful with #24.

This is actually nontrivial, though, because the role names within the objects.txt data lines aren't identical to the role commands used in the reST. (E.g., it's py:function inside the objects.txt, but :py:func:... in the reST.)

@bskinn bskinn added type: enhancement ✨ Something to add issue: maybe 🤔 Being considered, but not certain labels Nov 22, 2017
@bskinn bskinn added this to the Future milestone Dec 2, 2017
@bskinn
Copy link
Owner Author

bskinn commented Jan 8, 2018

Need to test whether using the full role name in a reST reference is still recognized by Sphinx.

If so, then this is already implemented by the as_rst property on the DataObjs!

@bskinn
Copy link
Owner Author

bskinn commented Aug 3, 2018

Nope, you have to use the shorter inline directives for cross-references, not the longer block directives.

@bskinn
Copy link
Owner Author

bskinn commented May 8, 2022

Superseded by #234.

@bskinn bskinn closed this as completed May 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue: maybe 🤔 Being considered, but not certain type: enhancement ✨ Something to add
Projects
None yet
Development

No branches or pull requests

1 participant