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

BUG links with bad format #167

Closed
prjemian opened this issue May 10, 2023 · 4 comments · Fixed by #272
Closed

BUG links with bad format #167

prjemian opened this issue May 10, 2023 · 4 comments · Fixed by #272
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@prjemian
Copy link
Contributor

On https://bcda-aps.github.io/bluesky_training/reference/_git-help.html, there are a couple links with broken formatting:

Clipboard01

@prjemian prjemian added bug Something isn't working documentation Improvements or additions to documentation labels May 10, 2023
@prjemian prjemian added this to the v1.0.0 milestone May 10, 2023
@rodolakis rodolakis self-assigned this May 11, 2023
@prjemian prjemian modified the milestones: v1.0.0, v1.0.1 Jun 5, 2023
@prjemian prjemian modified the milestones: v1.0.1, v1.0.2 Aug 21, 2023
@prjemian
Copy link
Contributor Author

The example shown has since been rewritten. No such problem exists with that documentation. Similar problems remain in other parts of the documentation, such as:

made available to the `databroker <#databroker>`__ via a shared volume from the

@prjemian
Copy link
Contributor Author

Other locations may be found locally after building the documentation, then searching the html files:

make -C docs clean html
grep -R "&gt;\`_" ./docs/build/html/

@prjemian
Copy link
Contributor Author

The problem is that formats cannot be combined in these situations.

[`bluesky_class.yml`](./bluesky_class.yml)

should be replaced by

[bluesky_class.yml](./bluesky_class.yml)

@prjemian
Copy link
Contributor Author

This command identifies such problem lines in the source code:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants