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

Add links to IDAES etc. on every page #53

Open
dangunter opened this issue Aug 2, 2021 · 3 comments
Open

Add links to IDAES etc. on every page #53

dangunter opened this issue Aug 2, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation Priority:Normal Medium Priority Issue or PR

Comments

@dangunter
Copy link
Contributor

In the Sphinx conf.py file, you can set a variable rst_epilog to a string whose contents will be interpreted as reStructuredText and appended at the bottom of every page of documentation. This could be used to add a link to IDAES and any other relevant dependencies on every page. It could also be used, as in the IDAES project, to define some shortcuts (substitutions) so links could be easily inserted and, if changed, updated in one place. See https://github.com/IDAES/idaes-pse/blob/main/docs/conf.py

@dangunter dangunter added the documentation Improvements or additions to documentation label Aug 2, 2021
@ksbeattie ksbeattie added the Priority:Normal Medium Priority Issue or PR label Aug 2, 2021
@ksbeattie
Copy link
Contributor

Here is an example of this being used in IDAES: https://idaes-pse.readthedocs.io/en/stable/tutorials_examples.html

@bknueven
Copy link
Collaborator

bknueven commented Nov 8, 2021

Related: if we're linking heavily into IDAES docs (a good idea), we should minimally running the docs linkcheck.

@ksbeattie
Copy link
Contributor

@dangunter suggests that another approach would be to have separate "dependencies" page listing what our dependencies are and links to them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Priority:Normal Medium Priority Issue or PR
Projects
None yet
Development

No branches or pull requests

4 participants