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

avoid certain reST syntax errors in documentation #272

Merged
merged 2 commits into from
Feb 26, 2024

Conversation

prjemian
Copy link
Contributor

@prjemian prjemian added the documentation Improvements or additions to documentation label Feb 24, 2024
@prjemian prjemian added this to the v1.0.2 milestone Feb 24, 2024
@prjemian prjemian self-assigned this Feb 24, 2024
@coveralls
Copy link

coveralls commented Feb 24, 2024

Pull Request Test Coverage Report for Build 8052088866

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 82.718%

Totals Coverage Status
Change from base Build 8052061533: 0.0%
Covered Lines: 986
Relevant Lines: 1192

💛 - Coveralls

@prjemian
Copy link
Contributor Author

Remaining occurrences are:

(base) .../bluesky_training$ git grep "\`]("
.wip/lessons/area-detector.ipynb:    "[`ADSimDetector`](https://github.com/areaDetector/ADSimDetector) \n",
.wip/lessons/diffractometer-4circle.ipynb:    "[`E4CV`](https://people.debian.org/~picca/hkl/hkl.html#orge78e5c4)\n",
.wip/lessons/diffractometer-4circle.ipynb:    "The [`DiffractometerMixin`](https://apstools.readthedocs.io/en/latest/source/_diffractometer.html)\n",
.wip/lessons/diffractometer-4circle.ipynb:    "[`Constraint`](https://apstools.readthedocs.io/en/latest/source/_diffractometer.html) object.\n",
bluesky/README.md:Introduction | [`intro2bluesky.md`](https://bcda-aps.github.io/bluesky_training/reference/_intro2bluesky.html)
bluesky/README.md:IPython console startup | [`console/`](console/README.md)
bluesky/README.md:Conda environments | [`environments/`](./environments/README.md)
bluesky/README.md:Unit tests | [`tests/`](./tests/README.md)
bluesky/environments/README.md:2024-1 (latest) | [`environment_2024_1.yml`](.//environment_2024_1.yml)
bluesky/environments/README.md:2023-3 | [`environment_2023_3.yml`](./environment_2023_3.yml)
bluesky/environments/README.md:2023-2 | [`environment_2023_2.yml`](./archive/environment_2023_2.yml)
bluesky/environments/README.md:2023-1 | [`environment_2023_1.yml`](./archive/environment_2023_1.yml)
bluesky/environments/README.md:2022_3 | [`environment_2022_3.yml`](./archive/environment_2022_3.yml)
bluesky/environments/README.md:2022_2 | [`environment_2022_2.yml`](./archive/environment_2022_2.yml)
bluesky/environments/README.md:2022_1 | [`environment_2022_1.yml`](./archive/environment_2022_1.yml)
bluesky/environments/README.md:2021_2 | [`environment_2021_2.yml`](./archive/environment_2021_2.yml)
bluesky/environments/README.md:2021_1 | [`environment_2021_1.yml`](./archive/environment_2021_1.yml)

The .wip directory can be ignored, the remaining instances are all in markdown files, which are rendered properly.

@prjemian
Copy link
Contributor Author

Suggest review, merge #275, then pull those changes into this PR. Easy to download & review the docs from the workflow run.

@prjemian
Copy link
Contributor Author

Review and merge PR #275 before this one. Then, pull and merge those changes here and push to see a copy of the this PR's changes.

Copy link
Collaborator

@MDecarabas MDecarabas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@prjemian
Copy link
Contributor Author

Thanks!

@prjemian prjemian merged commit 38189ef into main Feb 26, 2024
8 checks passed
@prjemian prjemian deleted the 167-link-with-bad-format branch February 26, 2024 18:23
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG links with bad format
3 participants