Metadata-Version: 2.4
Name: shsk_doc_writing_styles
Version: 0.2.1
Summary: A Claude Code plugin providing personal documentation writing style conventions.
Author-email: Sanhe Hu <husanhe@email.com>
Maintainer-email: Sanhe Hu <husanhe@email.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/MacHu-GWU/shsk_doc_writing_styles-project
Project-URL: Documentation, https://shsk-doc-writing-styles.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/MacHu-GWU/shsk_doc_writing_styles-project
Project-URL: Issues, https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/issues
Project-URL: Changelog, https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/blob/main/release-history.rst
Project-URL: Download, https://pypi.org/pypi/shsk-doc-writing-styles#files
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <4.0,>=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
License-File: AUTHORS.rst
Provides-Extra: dev
Requires-Dist: rich<14.0.0,>=13.8.1; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest<9.0.0,>=8.2.2; extra == "test"
Requires-Dist: pytest-cov<7.0.0,>=6.0.0; extra == "test"
Provides-Extra: doc
Requires-Dist: Sphinx<8.0.0,>=7.4.7; extra == "doc"
Requires-Dist: sphinx-copybutton<1.0.0,>=0.5.2; extra == "doc"
Requires-Dist: sphinx-design<1.0.0,>=0.6.1; extra == "doc"
Requires-Dist: sphinx-jinja<3.0.0,>=2.0.2; extra == "doc"
Requires-Dist: furo==2024.8.6; extra == "doc"
Requires-Dist: pygments<3.0.0,>=2.18.0; extra == "doc"
Requires-Dist: ipython<8.19.0,>=8.18.1; extra == "doc"
Requires-Dist: nbsphinx<1.0.0,>=0.8.12; extra == "doc"
Requires-Dist: rstobj==2.0.0; extra == "doc"
Requires-Dist: docfly==3.0.3; extra == "doc"
Provides-Extra: mise
Requires-Dist: PyGithub<3.0.0,>=2.8.0; extra == "mise"
Requires-Dist: httpx<1.0.0,>=0.28.0; extra == "mise"
Requires-Dist: tomli<3.0.0,>=2.0.0; python_version < "3.11" and extra == "mise"
Dynamic: license-file


.. image:: https://readthedocs.org/projects/shsk-doc-writing-styles/badge/?version=latest
    :target: https://shsk-doc-writing-styles.readthedocs.io/en/latest/
    :alt: Documentation Status

.. .. image:: https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/actions?query=workflow:CI

.. .. image:: https://codecov.io/gh/MacHu-GWU/shsk_doc_writing_styles-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/shsk_doc_writing_styles-project

.. .. image:: https://img.shields.io/pypi/v/shsk-doc-writing-styles.svg
    :target: https://pypi.python.org/pypi/shsk-doc-writing-styles

.. .. image:: https://img.shields.io/pypi/l/shsk-doc-writing-styles.svg
    :target: https://pypi.python.org/pypi/shsk-doc-writing-styles

.. .. image:: https://img.shields.io/pypi/pyversions/shsk-doc-writing-styles.svg
    :target: https://pypi.python.org/pypi/shsk-doc-writing-styles

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/shsk_doc_writing_styles-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://shsk-doc-writing-styles.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/shsk_doc_writing_styles-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/shsk-doc-writing-styles#files


Welcome to ``shsk_doc_writing_styles`` Documentation
==============================================================================
.. .. image:: https://shsk-doc-writing-styles.readthedocs.io/en/latest/_static/shsk_doc_writing_styles-logo.png
    :target: https://shsk-doc-writing-styles.readthedocs.io/en/latest/

``shsk_doc_writing_styles`` hosts the ``doc-writing-styles`` Claude Code plugin, under `.claude/skills/doc-writing-styles/ <https://github.com/MacHu-GWU/shsk_doc_writing_styles-project/tree/main/.claude/skills/doc-writing-styles>`_ a personal set of skills that enforce consistent documentation writing conventions: Markdown structure and tone, mixed Chinese/English punctuation, and English translation of existing documents.


.. _install:

Install
------------------------------------------------------------------------------

``shsk_doc_writing_styles`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install shsk-doc-writing-styles

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade shsk-doc-writing-styles
