Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 51b83d3

Browse files
committedMay 28, 2022
📚 [guide] Convert remaining tables to list-table
1 parent d7fde46 commit 51b83d3

File tree

1 file changed

+37
-35
lines changed

1 file changed

+37
-35
lines changed
 

‎docs/guide.md

+37-35
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@ substitutions:
33
HPC: "*Hypermodern Python Cookiecutter*"
44
---
55

6-
<!--
7-
- TODO convert tables to native Markdown
8-
-->
9-
106
# User Guide
117

128
This is the user guide
@@ -376,48 +372,54 @@ For more details on these files, refer to the section [The initial package](the-
376372
The test suite is located in the `tests` directory.
377373
For more details on these files, refer to the section [The test suite](the-test-suite).
378374

379-
```{eval-rst}
380-
.. table:: Test suite
381-
:widths: auto
375+
:::{list-table} Test suite
376+
:widths: auto
382377

383-
===================================== ===============================
384-
``tests/__init__.py`` Test package initialization
385-
``tests/test_main.py`` Test cases for ``__main__``
386-
===================================== ===============================
387-
```
378+
- - `tests/__init__.py`
379+
- Test package initialization
380+
- - `tests/test_main.py`
381+
- Test cases for `__main__`
382+
383+
:::
388384

389385
The project documentation is written in [Markdown].
390386
The documentation files in the top-level directory are rendered on [GitHub]:
391387

392-
```{eval-rst}
393-
.. table:: Documentation files (top-level)
394-
:widths: auto
388+
:::{list-table} Documentation files (top-level)
389+
:widths: auto
395390

396-
====================== ============================================
397-
``README.md`` Project description for GitHub and PyPI
398-
``CONTRIBUTING.md`` Contributor Guide
399-
``CODE_OF_CONDUCT.md`` Code of Conduct
400-
``LICENSE`` License
401-
====================== ============================================
402-
```
391+
- - `README.md`
392+
- Project description for GitHub and PyPI
393+
- - `CONTRIBUTING.md`
394+
- Contributor Guide
395+
- - `CODE_OF_CONDUCT.md`
396+
- Code of Conduct
397+
- - `LICENSE`
398+
- License
399+
400+
:::
403401

404402
The files in the `docs` directory are
405403
built using [Sphinx](documentation) and [MyST].
406404
The Sphinx documentation is hosted on [Read the Docs](read-the-docs-integration):
407405

408-
```{eval-rst}
409-
.. table:: Documentation files (Sphinx)
410-
:widths: auto
411-
412-
===================== =======================================================
413-
``index.md`` Main document
414-
``contributing.md`` Contributor Guide (via include)
415-
``codeofconduct.md`` Code of Conduct (via include)
416-
``license.md`` License (via include)
417-
``reference.md`` API reference
418-
``usage.md`` Command-line reference
419-
===================== =======================================================
420-
```
406+
:::{list-table} Documentation files (Sphinx)
407+
:widths: auto
408+
409+
- - `index.md`
410+
- Main document
411+
- - `contributing.md`
412+
- Contributor Guide (via include)
413+
- - `codeofconduct.md`
414+
- Code of Conduct (via include)
415+
- - `license.md`
416+
- License (via include)
417+
- - `reference.md`
418+
- API reference
419+
- - `usage.md`
420+
- Command-line reference
421+
422+
:::
421423

422424
The `.github/workflows` directory contains the [GitHub Actions workflows](github-actions-workflows):
423425

0 commit comments

Comments
 (0)
Please sign in to comment.