Skip to content

Commit 9396dcc

Browse files
jonathansickjonathansick
authored
Merge pull request #221 from lsst-sqre/tickets/DM-43617
DM-43617: Fix Source parser for markdown not registered error for technotes
2 parents 0c2ea3a + 95d5eda commit 9396dcc

File tree

11 files changed

+145
-2
lines changed

11 files changed

+145
-2
lines changed

‎.github/workflows/ci-cron.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,16 @@ jobs:
4141
npm install
4242
npm run build
4343
44+
- name: Install graphviz
45+
run: |
46+
sudo apt-get update
47+
sudo apt-get install graphviz
48+
4449
- name: Run tests in tox
4550
uses: lsst-sqre/run-tox@v1
4651
with:
4752
python-version: ${{ matrix.python-version }}
48-
tox-envs: "lint,typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }}"
53+
tox-envs: "lint,typing-sphinx${{ matrix.sphinx-version }},py-test-sphinx${{ matrix.sphinx-version }},demo"
4954
use-cache: false
5055

5156
docs:

‎.github/workflows/ci.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,16 @@ jobs:
6161
npm install
6262
npm run build
6363
64+
- name: Install graphviz
65+
run: |
66+
sudo apt-get update
67+
sudo apt-get install graphviz
68+
6469
- name: Run tox
6570
uses: lsst-sqre/run-tox@v1
6671
with:
6772
python-version: ${{ matrix.python-version }}
68-
tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }}'
73+
tox-envs: 'py-test-sphinx${{ matrix.sphinx-version }},typing-sphinx${{ matrix.sphinx-version }},demo'
6974

7075
docs:
7176
runs-on: ubuntu-latest

‎CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
<!-- scriv-insert-here -->
44

5+
<a id='changelog-1.2.1'></a>
6+
## 1.2.1 (2024-04-02)
7+
8+
### Bug fixes
9+
10+
- Fix the "Source parser for markdown not registered" error for Markdown-based technotes. With the MyST-NB extension the Markdown parser is automatically registered, so the `documenteer.conf.technote` configuration now resets the `source_suffix` configuration originally created by the Technote package.
11+
512
<a id='changelog-1.2.0'></a>
613
## 1.2.0 (2024-03-26)
714

‎demo/md-technote/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
_build
2+
.technote

‎demo/md-technote/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.PHONY:
2+
clean:
3+
rm -rf _build

‎demo/md-technote/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from documenteer.conf.technote import * # noqa F401 F403

‎demo/md-technote/diagram.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
from diagrams.k8s.clusterconfig import HPA
2+
from diagrams.k8s.compute import Deployment, Pod, ReplicaSet
3+
from diagrams.k8s.network import Ingress, Service
4+
from sphinx_diagrams import SphinxDiagram
5+
6+
with SphinxDiagram(title="GKE"):
7+
net = Ingress("domain.com") >> Service("svc")
8+
(
9+
net
10+
>> [Pod("pod1"), Pod("pod2"), Pod("pod3")]
11+
<< ReplicaSet("rs")
12+
<< Deployment("dp")
13+
<< HPA("hpa")
14+
)

‎demo/md-technote/index.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Demo technote
2+
3+
```{abstract}
4+
A *technote* is a web-native single page document that enables rapid technical communication within and across teams.
5+
```
6+
7+
## Introduction
8+
9+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
10+
11+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
12+
13+
A parenthetical citation {cite:p}`2017arXiv170309824V`. And a textual citation {cite:t}`2017arXiv170309824V`.
14+
15+
## Method
16+
17+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
18+
19+
A list:
20+
21+
- First item
22+
- Second item
23+
- Third item
24+
25+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
26+
27+
```{code-block} python
28+
:caption: hello.py
29+
30+
print("Hello world")
31+
```
32+
33+
## Results
34+
35+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
36+
37+
### Subsection
38+
39+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
40+
41+
#### Subsubsection
42+
43+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
44+
45+
## Analysis
46+
47+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
48+
49+
```{prompt} bash
50+
git add index.rst
51+
```
52+
53+
Some following text.
54+
55+
```{mermaid}
56+
graph TD
57+
A[Square Rect] -- Link text --> B((Circle))
58+
A --> C(Round Rect)
59+
B --> D{Rhombus}
60+
C --> D
61+
```
62+
63+
```{diagrams} diagram.py
64+
```
65+
66+
## Conclusion
67+
68+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
69+
70+
## References
71+
72+
```{bibliography}
73+
```

‎demo/md-technote/technote.toml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[technote]
2+
id = "SQR-000"
3+
series_id = "SQR"
4+
canonical_url = "https://sqr-000.lsst.io"
5+
github_url = "https://github.com/lsst-sqre/sqr-000"
6+
github_default_branch = "master"
7+
date_created = 2015-11-18
8+
date_updated = 2015-11-23
9+
version = "1.0.0"
10+
11+
[[technote.authors]]
12+
name.given = "Jonathan"
13+
name.family = "Sick"
14+
orcid = "https://orcid.org/0000-0003-3001-676X"
15+
affiliations = [
16+
{ name = "Rubin Observatory", ror = "https://ror.org/048g3cy84" }
17+
]
18+
19+
[[technote.authors]]
20+
name.given = "Frossie"
21+
name.family = "Economou"
22+
23+
[[technote.authors]]
24+
name.given = "Russ"
25+
name.family = "Allbery"

‎src/documenteer/conf/technote.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@
4343
]
4444
)
4545

46+
# The source file suffixes for .md and .ipynb are automatically managed by
47+
# myst-nb.
48+
source_suffix = {
49+
".rst": "restructuredtext",
50+
}
51+
4652
html_static_path: list[str] = [
4753
get_asset_path("rubin-favicon-transparent-32px.png"),
4854
get_asset_path("rubin-favicon.svg"),

‎tox.ini

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,7 @@ allowlist_externals =
8484
commands =
8585
rm -rf demo/rst-technote/_build
8686
sphinx-build --keep-going -n -W -T -b html -d {envtmpdir}/doctrees demo/rst-technote demo/rst-technote/_build/html
87+
rm -rf demo/md-technote/_build
88+
sphinx-build --keep-going -n -W -T -b html -d {envtmpdir}/doctrees demo/md-technote demo/md-technote/_build/html
8789
rm -rf demo/ipynb-technote/_build
8890
sphinx-build --keep-going -n -W -T -b html -d {envtmpdir}/doctrees demo/ipynb-technote demo/ipynb-technote/_build/html

0 commit comments

Comments
 (0)