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

Enable auto-cross-referencing #14

Open
rtopfer opened this issue Jun 22, 2020 · 0 comments
Open

Enable auto-cross-referencing #14

rtopfer opened this issue Jun 22, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@rtopfer
Copy link
Contributor

rtopfer commented Jun 22, 2020

Once a Documentor instance has been initialized (the documentation content drafted and the output file structure assigned), the drafted documentation could be scanned for keywords (e.g. names of the assigned functions,scripts,classes, etc.) and cross-referencing relative links could be inserted (e.g. first instance of a keyword in a given entry, and/or into the standard % See also footer)

Requires deciding which among the approaches listed here would be easiest to use.


Separate but related feature request:
Auto-addition of hyperlinks to the corresponding GitHub code would be a nice option

E.g. the URL to the .m file could be included beneath the doc title + synopsis.

If the file structure is kept the same (i.e. doc directory tree mirrors that of the code) or simply if a key-map was output by the documentation process (i.e. this .md entry correspond to that .m file) then it should be reasonably straightforward? Is this something readthedocs or git/GitHub already support?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant