BCDA-APS / bluesky_training

Bluesky training, including instrument package
https://bcda-aps.github.io/bluesky_training/
Other
11 stars 0 forks source link

avoid certain reST syntax errors in documentation #272

Closed prjemian closed 4 months ago

prjemian commented 4 months ago
coveralls commented 4 months ago

Pull Request Test Coverage Report for Build 8052088866

Details


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

💛 - Coveralls
prjemian commented 4 months ago

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 commented 4 months ago

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

prjemian commented 4 months ago

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.

prjemian commented 4 months ago

Thanks!