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

Option as headings not well documented #114

Open
DreamingRaven opened this issue Aug 23, 2019 · 0 comments
Open

Option as headings not well documented #114

DreamingRaven opened this issue Aug 23, 2019 · 0 comments

Comments

@DreamingRaven
Copy link

DreamingRaven commented Aug 23, 2019

#46 is not well documented, and with experimentation, and an extensive read through what is available short of reading source, I still could not get the anchors to work. Is there any way an example could be provided for both duplicate and non duplicate headers?

I am working on linking to "Deep learning options" -- which is autogenerated from sphinx-argparse -- to any other file in the project but none of the methods I have tried thus far work including:

Trying to call the anchor as it apparently should be under the same name

`Deep learning options`_
`Deep_learning_options`_
/home/archer/git/nemesyst/docs/source/overview.rst:48: WARNING: Unknown target name: "deep learning options".

Trying to call the anchor as if it was a duplicate by "prepending" _repeatX:

`_repeat0Deep learning options`_
`_repeat1Deep learning options`_
`_repeatXDeep learning options`_
/home/archer/git/nemesyst/docs/source/overview.rst:48: WARNING: Unknown target name: "_repeat0deep learning options".

Using ref?

:ref:`Deep learning options`
/home/archer/git/nemesyst/docs/source/overview.rst:48: WARNING: undefined label: deep learning options (if the link has no caption the label must precede a section header)

Any help to get a link to the (sphinx-argparse) auto-generated section without pasting a html link would be hugely appreciated. Also is automatically changing the anchor name to lower case an expected behaviour as each error message says "deep learning options" but not "Deep learning options" which is what I use to call the anchor, and what the anchors name should be if it is the header name.

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

No branches or pull requests

1 participant