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

formatting problems in documentation #927

Closed
prjemian opened this issue Feb 26, 2024 · 1 comment · Fixed by #928
Closed

formatting problems in documentation #927

prjemian opened this issue Feb 26, 2024 · 1 comment · Fixed by #928
Assignees
@prjemian
Labels
documentation
Milestone
1.6.19

Comments

@prjemian
Copy link
Contributor

Similar to BCDA-APS/bluesky_training#167, there are some problems when using nested formatting markup in jupyter notebooks. The comments are in markdown format but are rendered in the build workflow through reST. It is reST that does not allow nested formatting.

- [`trouble`](./file.txt)
- [no trouble](./file.txt)

See the referenced issue for an example of how it looks when rendered.
@prjemian prjemian added this to the 1.6.19 milestone Feb 26, 2024
@prjemian prjemian self-assigned this Feb 26, 2024
@prjemian
Copy link
Contributor Author

This command identifies problem lines in the source code:

grep -R "\`](" ./docs/source

prjemian added a commit that referenced this issue Feb 26, 2024
@prjemian
DOC #927 remove problematic nested formatting in notebooks
cd3815a
@prjemian prjemian mentioned this issue Feb 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@prjemian prjemian

Labels
documentation
Projects
None yet
Milestone
1.6.19
Development

Successfully merging a pull request may close this issue.

remove problematic nested formatting in notebooks BCDA-APS/apstools
1 participant
@prjemian