Skip to content

Commit c4ba158

Browse files
committed
docs: port foo.rst to foo.md
I like to write documentation in MarkDown better than in `*.rst`. First step is to have new package documentation in MarkDown. So port the reference `foo.rst` to `foo.md.
1 parent 5965a8a commit c4ba158

File tree

3 files changed

+23
-22
lines changed

3 files changed

+23
-22
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484

8585
# List of patterns, relative to source directory, that match files and
8686
# directories to ignore when looking for source files.
87-
exclude_patterns = ['_build', '_venv', 'rtfd-css', 'packages/pkg/foo.rst', 'old-wiki']
87+
exclude_patterns = ['_build', '_venv', 'rtfd-css', 'packages/pkg/foo.md', 'old-wiki']
8888

8989
# The reST default role (used for this markup: `text`) to use for all
9090
# documents.

docs/packages/pkg/foo.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
```{spelling}
2+
3+
foo
4+
```
5+
6+
```{index} single: unsorted ; foo
7+
```
8+
9+
(pkg.foo)=
10+
11+
# foo
12+
13+
- [Official](https://official_foo)
14+
- [Hunterized](https://github.com/cpp-pm/foo)
15+
- [Example](https://github.com/cpp-pm/hunter/blob/master/examples/foo/CMakeLists.txt)
16+
- Added by [foo_developer](https://github.com/foo_developer) ([pr-N](https://github.com/cpp-pm/hunter/pull/N))
17+
18+
```{literalinclude} /../examples/foo/CMakeLists.txt
19+
:language: cmake
20+
:start-after: "# DOCUMENTATION_START {"
21+
:end-before: "# DOCUMENTATION_END }"
22+
```

docs/packages/pkg/foo.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

0 commit comments

Comments
 (0)