RE: [PATCH 0/2] mmc-utils: Elaborate Documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



A gentle ping.

Thanks,
Avri

> Here is an elaboration of documentations to pair up with the recent
> addition of mmc-utils man page. It adds a public page:
> https://mmc-utils.readthedocs.io/en/latest/.
> 
> Shamefully, I recently became aware that Marcus Folkesson already added
> a man page quite some time ago, so this time I double-checked that
> Read-the-Docs doesn't already have a mmc-utils page.
> 
> One thing that can greatly improve this page is an "examples" section.
> A good practice would be for field application and validation engineers
> that uses the tool daily to share their use-cases and practice.
> 
> Keeping the documentation page updated, I created a github repo to
> mirror mmc-utils official repo and can be imported and re-built -
> https://github.com/avri-altman-wdc/mmc-utils.
> 
> Avri Altman (2):
>   mmc-utils: Add documentation section
>   mmc-utils: Add Read-the-Docs configuration
> 
>  .gitignore            |  1 +
>  .readthedocs.yaml     | 17 ++++++++++
>  Makefile              |  5 +++
>  README                |  6 +++-
>  docs/HOWTO.rst        | 67 ++++++++++++++++++++++++++++++++++++++
>  docs/Makefile         | 20 ++++++++++++
>  docs/README.rst       | 76 +++++++++++++++++++++++++++++++++++++++++++
>  docs/conf.py          | 53 ++++++++++++++++++++++++++++++
>  docs/index.rst        | 17 ++++++++++
>  docs/requirements.txt |  2 ++
>  10 files changed, 263 insertions(+), 1 deletion(-)
>  create mode 100644 .readthedocs.yaml
>  create mode 100644 docs/HOWTO.rst
>  create mode 100644 docs/Makefile
>  create mode 100644 docs/README.rst
>  create mode 100644 docs/conf.py
>  create mode 100644 docs/index.rst
>  create mode 100644 docs/requirements.txt
> 
> --
> 2.34.1






[Index of Archives]     [Linux Memonry Technology]     [Linux USB Devel]     [Linux Media]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux