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.

Sign up for GitHub

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

Jump to bottom

Improve autolink to files in MooseDocs #14883

Open
aeslaughter opened this issue Mar 12, 2020 · 0 comments
Open

Improve autolink to files in MooseDocs #14883

aeslaughter opened this issue Mar 12, 2020 · 0 comments
Labels
C: Documentation Good first issue P: normal A defect affecting operation with a low possibility of significantly affects. T: task An enhancement to the software.

Comments

@aeslaughter
Copy link
Contributor

Reason

Currently, syntax like [foo.i] will automatically create a link with popup to the source code, the mechanism for this is fragile because it is required to fall through for traditional markdown shortcut syntax.

Design

The autolink.py extension of MooseDocs should define a command for this rather than trying to be automatic: [!file](foo.i)

Impact

The documentation for moose and the apps will need to be updated, but the current method can be deprecated first while the update happens.
@aeslaughter aeslaughter added T: task An enhancement to the software. P: normal A defect affecting operation with a low possibility of significantly affects. C: Documentation Good first issue labels Mar 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C: Documentation Good first issue P: normal A defect affecting operation with a low possibility of significantly affects. T: task An enhancement to the software.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aeslaughter