From d9e6a1da7c7d8d3e06393a0f3e864b1d3af7493f Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Wed, 11 Sep 2024 20:49:42 +0100 Subject: [PATCH] Progress towards docs --- README.rst | 2 +- docs/source/index.rst | 50 +++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- 3 files changed, 52 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e174bfb..4f36578 100644 --- a/README.rst +++ b/README.rst @@ -75,7 +75,7 @@ What does it work on? TODO: -* Add documentation (automated, and link to it, and add pre-commits for Sphinx stuff, update urls.Source) +* Add documentation (automated, and add pre-commits for Sphinx stuff) * Release pre-commit hook * Verbose mode... "Running command "X" against README.rst example from line ..." * Option to not delete file diff --git a/docs/source/index.rst b/docs/source/index.rst index e69de29..d3038c9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -0,0 +1,50 @@ +|project| +========= + +A command line tool for running commands against documentation files. + +.. include:: install.rst + +.. include:: usage-example.rst + +What does it work on? +--------------------- + +* reStructuredText (`.rst`) + +.. code-block:: rst + + .. code-block:: shell + + echo "Hello, world!" + +* Markdown (`.md`) + +.. code-block:: markdown + + ```shell + echo "Hello, world!" + ``` + +* MyST (`.md` with MyST syntax) + +.. code-block:: markdown + + ```{code-block} shell + echo "Hello, world!" + ``` + +* Want more? Open an issue! + +Reference +--------- + +.. toctree:: + :maxdepth: 3 + + install + usage-example + commands + contributing + release-process + changelog diff --git a/pyproject.toml b/pyproject.toml index bfb3023..71467cc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -77,7 +77,7 @@ optional-dependencies.dev = [ optional-dependencies.packaging = [ "pyinstaller==6.10.0", ] -urls.Source = "https://github.com/adamtheturtle/doccmd" +urls.Source = "https://doccmd.readthedocs.io/en/latest/" scripts.doccmd = "doccmd:main" [tool.setuptools]