Metadata-Version: 2.1
Name: pyscaffoldext-markdown
Version: 0.4
Summary: PyScaffold extension which uses Markdown instead of reStructuredText
Home-page: https://github.com/pyscaffold/pyscaffoldext-markdown
Author: Florian Wilhelm
Author-email: florian.wilhelm@inovex.de
License: MIT
Project-URL: Documentation, https://pyscaffold.org/
Project-URL: Source, https://github.com/pyscaffold/pyscaffoldext-markdown/
Project-URL: Tracker, https://github.com/pyscaffold/pyscaffoldext-markdown/
Project-URL: Download, https://pypi.org/project/pyscaffoldext-markdown/#files
Description: [![Build Status](https://api.cirrus-ci.com/github/pyscaffold/pyscaffoldext-markdown.svg?branch=master)](https://cirrus-ci.com/github/pyscaffold/pyscaffoldext-markdown)
        [![ReadTheDocs](https://readthedocs.org/projects/pyscaffoldext-markdown/badge/?version=latest)](https://pyscaffoldext-markdown.readthedocs.io/)
        [![Coveralls](https://img.shields.io/coveralls/github/pyscaffold/pyscaffoldext-markdown/master.svg)](https://coveralls.io/r/pyscaffold/pyscaffoldext-markdown)
        [![PyPI-Server](https://img.shields.io/pypi/v/pyscaffoldext-markdown.svg)](https://pypi.org/project/pyscaffoldext-markdown)
        [![Downloads](https://pepy.tech/badge/pyscaffoldext-markdown/month)](https://pepy.tech/project/pyscaffoldext-markdown)
        
        
        # pyscaffoldext-markdown
        
        [PyScaffold] extension which replaces [reStructuredText] formatted files
        by [Markdown] format except for [Sphinx]-related files.
        
        
        ## Usage
        
        Just install this package with `pip install pyscaffoldext-markdown`
        and note that `putup -h` shows a new option `--markdown`.
        Basically this extension will replace `README.rst` by a proper `README.md` and
        activate the support of Markdown files in Sphinx.
        
        
        ## Limitations
        
        Due to limitations of the Markdown syntax compared to [reStructuredText],
        it is necessary to use symbolic links (and some reStructuredText files) to
        avoid keeping multiple copies of files (such as `CHANGELOG.md`) meant to be
        placed at the root of the repository but included in the documentation
        generated by [Sphinx]. If you are a Windows user please make sure to configure
        your system accordingly. The following references might be helpful:
        
        *Symbolic links on Windows*
        
        - [http://github.com/git-for-windows/git/wiki/Symbolic-Links](http://github.com/git-for-windows/git/wiki/Symbolic-Links)
        - [https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/)
        - [https://docs.microsoft.com/en-us/windows/win32/fileio/creating-symbolic-links](https://docs.microsoft.com/en-us/windows/win32/fileio/creating-symbolic-links)
        
        *Markdown limitations*
        
        - [https://github.com/readthedocs/recommonmark/issues/191](https://github.com/readthedocs/recommonmark/issues/191)
        - [https://github.com/sphinx-doc/sphinx/issues/701](https://github.com/sphinx-doc/sphinx/issues/701)
        - [https://github.com/sphinx-doc/sphinx/pull/7739](https://github.com/sphinx-doc/sphinx/pull/7739)
        
        Windows users that still face problems after configuring their systems for
        symbolic links might want to attempt [WSL] or decide to stick with [reStructuredText]
        for (problematic) parts of their documentation files.
        
        
        ## Building and Releasing
        
        By default, the [tox] configuration generated by [PyScaffold] is compatible
        with Markdown (as implemented in this extension). This means that (after
        installing [tox] with [pip] or [pipx]) you can run:
        
        ```bash
        tox -e docs  # to build your documentation
        tox -e build  # to build your package distribution
        tox -e publish  # to test your project uploads correctly in test.pypi.org
        tox -e publish -- --repository pypi  # to release your package to PyPI
        tox -av  # to list all the tasks available
        ```
        
        Please remember that the command `python setup.py release` is no longer
        recommended, so if you don't like [tox], please consider using
        [Sphinx] and [twine] directly:
        
        ```bash
        python -m pip install -U pip setuptools wheel sphinx twine
        python setup.py bdist_wheel  # to build your package distributions
        make -C docs html  # to build your docs
        twine upload dist/*  # to release your package to PyPI
        ```
        
        <!-- pyscaffold-notes -->
        
        ## Making Changes & Contributing
        
        This project uses [pre-commit], please make sure to install it before making any
        changes:
        
        ```bash
        pip install pre-commit
        cd pyscaffoldext-markdown
        pre-commit install
        ```
        
        It is a good idea to update the hooks to the latest version:
        
        ```bash
        pre-commit autoupdate
        ```
        
        Please also check PyScaffold's [contribution guidelines].
        
        
        ## Note
        
        This project has been set up using PyScaffold 4.0. For details and usage
        information on PyScaffold see [https://pyscaffold.org/](https://pyscaffold.org/).
        
        [PyScaffold]: https://pyscaffold.org
        [reStructuredText]: http://docutils.sourceforge.net/rst.html
        [Markdown]: https://daringfireball.net/projects/markdown/
        [Sphinx]: http://www.sphinx-doc.org/
        [WSL]: https://docs.microsoft.com/en-us/windows/wsl/
        [tox]: https://tox.readthedocs.org/
        [pip]: https://pip.pypa.io/en/stable/
        [pipx]: https://pipxproject.github.io/pipx/
        [twine]: https://twine.readthedocs.io/
        [PyPI]: https://pypi.org/
        [pre-commit]: http://pre-commit.com/
        [contribution guidelines]: https://pyscaffold.org/en/latest/contributing.html
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.6
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Provides-Extra: testing
