@@ -3,10 +3,6 @@ substitutions:
3
3
HPC : " *Hypermodern Python Cookiecutter*"
4
4
---
5
5
6
- <!--
7
- - TODO convert tables to native Markdown
8
- -->
9
-
10
6
# User Guide
11
7
12
8
This is the user guide
@@ -376,48 +372,54 @@ For more details on these files, refer to the section [The initial package](the-
376
372
The test suite is located in the ` tests ` directory.
377
373
For more details on these files, refer to the section [ The test suite] ( the-test-suite ) .
378
374
379
- ``` {eval-rst}
380
- .. table:: Test suite
381
- :widths: auto
375
+ :::{list-table} Test suite
376
+ :widths: auto
382
377
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
+ :::
388
384
389
385
The project documentation is written in [ Markdown] .
390
386
The documentation files in the top-level directory are rendered on [ GitHub] :
391
387
392
- ``` {eval-rst}
393
- .. table:: Documentation files (top-level)
394
- :widths: auto
388
+ :::{list-table} Documentation files (top-level)
389
+ :widths: auto
395
390
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
+ :::
403
401
404
402
The files in the ` docs ` directory are
405
403
built using [ Sphinx] ( documentation ) and [ MyST] .
406
404
The Sphinx documentation is hosted on [ Read the Docs] ( read-the-docs-integration ) :
407
405
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
+ :::
421
423
422
424
The ` .github/workflows ` directory contains the [ GitHub Actions workflows] ( github-actions-workflows ) :
423
425
0 commit comments