Skip to content

Commit

Permalink
Progress towards docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamtheturtle committed Sep 11, 2024
1 parent 02ec53a commit d9e6a1d
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
50 changes: 50 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit d9e6a1d

Please sign in to comment.