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

documentation: internal links and table of contents for API.html #19

Open
horstjens opened this issue Dec 3, 2014 · 4 comments
Open

Comments

@horstjens
Copy link
Collaborator

in file https://github.com/robertlugg/easygui/blob/master/documentation/api.html
it would be fantastic to have internal links for each easygui function ( msgbox, buttonbox, yesnobox etc) and have sphinx make an table of content with hyperlinks in the upper left corner (left sidebar). this would remove the need to browse the very long api text (or use strg+f) if you already know the name of a function but want to look up it's exact parameters. Likewise, it would give the reader an fast-to-recognize overview over all easygui functions.

@robertlugg
Copy link
Owner

Any idea how to do this in Sphinx/rst. I've tried several variants without success :(

@horstjens
Copy link
Collaborator Author

have you tried making headlines (h1, h2) for each of the function descriptions (msgbox, enterbox etc)? that should auto-create a table of content at the top i think.

@robertlugg robertlugg self-assigned this Dec 11, 2014
@robertlugg
Copy link
Owner

I was hoping to do it in an automated way. But I can create them by hand if necessary.

@robertlugg robertlugg removed their assignment Dec 24, 2014
@robertlugg
Copy link
Owner

I couldn't really figure this one out, so I'm going to delay it to focus on other work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants