Metadata-Version: 2.1
Name: sphinx-github-changelog
Version: 1.0.2
Summary: Build a sphinx changelog from GitHub Releases
Home-page: https://github.com/peopledoc/sphinx-github-changelog
Author: Joachim Jablon
Author-email: joachim.jablon@people-doc.com
License: MIT License
Project-URL: GitHub, https://github.com/peopledoc/sphinx-github-changelog
Project-URL: Documentation, https://sphinx-github-changelog.readthedocs.io
Project-URL: Changelog, https://sphinx-github-changelog.readthedocs.io/en/stable/changelog.html
Project-URL: Issue tracker, https://github.com/peopledoc/sphinx-github-changelog/issues
Description: Sphinx Github Changelog: Build a sphinx changelog from GitHub Releases
        ======================================================================
        
        .. image:: https://badge.fury.io/py/sphinx-github-changelog.svg
            :target: https://pypi.org/pypi/sphinx-github-changelog
            :alt: Deployed to PyPI
        
        .. image:: https://readthedocs.org/projects/sphinx-github-changelog/badge/?version=latest
            :target: http://sphinx-github-changelog.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://travis-ci.org/peopledoc/sphinx-github-changelog.svg?branch=main
            :target: https://travis-ci.org/peopledoc/sphinx-github-changelog
            :alt: Continuous Integration Status
        
        .. image:: https://codecov.io/gh/peopledoc/sphinx-github-changelog/branch/main/graph/badge.svg
            :target: https://codecov.io/gh/peopledoc/sphinx-github-changelog
            :alt: Coverage Status
        
        .. image:: https://img.shields.io/badge/License-MIT-green.svg
            :target: https://github.com/peopledoc/sphinx-github-changelog/blob/main/LICENSE
            :alt: MIT License
        
        .. image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg
            :target: CODE_OF_CONDUCT.md
            :alt: Contributor Covenant
        
        Sphinx-github-changelog is a Sphinx_ plugin that builds a changelog section based on
        a repository's `GitHub Releases`_ content.
        
        .. _Sphinx: https://www.sphinx-doc.org/en/master/
        .. _`GitHub Releases`: https://docs.github.com/en/github/administering-a-repository/about-releases
        
        How ? (the short version)
        =========================
        
        In your Sphinx documentation ``conf.py``::
        
            extensions = [
                ...,  # your other extensions
                "sphinx_github_changelog",
            ]
        
            # Provide a GitHub API token:
            # Pass the SPHINX_GITHUB_CHANGELOG_TOKEN environment variable to your build
            # OR
            sphinx_github_changelog_token = "..."
        
        In your documentation:
        
        .. code-block:: restructuredtext
        
            .. changelog::
                :changelog-url: https://your-project.readthedocs.io/en/stable/#changelog
                :github: https://github.com/you/your-project/releases/
                :pypi: https://pypi.org/project/your-project/
        
        
        See the end result for this project on ReadTheDocs__.
        
        .. __: https://sphinx-github-changelog.readthedocs.io/en/stable/#changelog
        
        Why ?
        =====
        
        On the way to continuous delivery, it's important to be able to release easily.
        One of the criteria for easy releases is that the release doesn't require a commit and
        a Pull Request. Release Pull Requests usually include 2 parts:
        
        - Changing the version
        - Updating the changelog (if you keep a changelog, let's assume you do)
        
        Commitless releases need a way to store the version and the changelog, as close as
        possible to the code, but actually **not in** the code.
        
        Setting aside the "version" question, ``sphinx-github-changelog`` aims at providing
        a good way of managing the "changelog" part:
        
        The best solution we've found so far for the changelog is to store it in the body of
        `GitHub Releases`_. That's very practical for maintainers, but it may not be the first
        place people will look for it. As far as we've seen, people expect the changelog to
        be:
        
        - in the repo, in ``CHANGELOG.rst``,
        - in the documentation.
        
        Having the changelog in ``CHANGELOG.rst`` causes a few problems:
        
        - Either each PR adds its single line of changelog, but:
        
          - you'll most probably run into countless merge conflicts,
          - the changelog won't tell you which contribution was part of which release
        
          This reduces the interest for the whole thing.
        
        - Or your changelog is edited at release time. Maybe you're using towncrier_ for
          fragment-based changelog, but you're not doing commitless releases anymore. You could
          imagine that the release commit is done by your CI, but this can quickly become
          annoying, especially if you require Pull Requests.
        
        But there is another way. Instead of providing the changelog, the ``CHANGELOG.rst``
        file can hold a *link* to the changelog. This makes things much easier.
        ``sphinx-github-changelog`` encourages you to do that.
        
        A complete toolbelt
        -------------------
        
        Alongside ``sphinx-github-changelog``, we suggest a few tools that play nice together:
        
        - `setuptools-scm`_ will compute your version in ``setup.py`` based on git tags.
        - `release-drafter`_ will keep a "Draft release" updated as you merge Pull Requests to
          your repository, so you just have to slightly adjust the release body, and create a
          tag.
        - Any Continuous Integration solution should be able to listen to new tags, and build
          and upload distributions to PyPI. Don't forget to use `PyPI API tokens`_!
        - And ReadTheDocs_ to host your built documentation, of course.
        
        .. _`setuptools-scm`: https://pypi.org/project/setuptools-scm/
        .. _`release-drafter`: https://help.github.com/en/github/administering-a-repository/about-releases
        .. _towncrier: https://pypi.org/project/towncrier/
        .. _`PyPI API tokens`: https://pypi.org/help/#token
        .. _ReadTheDocs: https://readthedocs.org/
        
        If you're using all the tools above, then releasing is simple as proof-reading the
        draft GitHub Release and press "Publish Release". That's it.
        
        Reference documentation
        =======================
        
        Extension options (``conf.py``)
        -------------------------------
        
        - ``changelog_github_token``: GitHub API token, with read access to the repository.
          Defaults to the value of the environment variable ``SPHINX_GITHUB_CHANGELOG_TOKEN``.
          If no value is provided, the build will still pass but the changelog will not be
          built, and a link to the ``changelog-url`` will be displayed (if provided).
        
        Directive
        ---------
        
        .. code-block:: restructuredtext
        
            .. changelog::
                :changelog-url: https://your-project.readthedocs.io/en/stable/changelog.html
                :github: https://github.com/you/your-project/releases/
                :pypi: https://pypi.org/project/your-project/
        
        Attributes
        ~~~~~~~~~~
        
        - ``github`` (**required**): URL to the releases page of the repository.
        - ``changelog-url`` (optional): URL to the built version of your changelog.
          ``sphinx-github-changelog`` will display a link to your built changelog if the GitHub
          token is not provided (hopefully, this does not happen in your built documentation)
        - ``pypi`` (optional): URL to the PyPI page of the repository. This allows the changelog
          to display links to each PyPI release.
        
        You'll notice that each parameter here is not requested in the simplest form but as
        very specific URLs from which the program extracts the needed information. This is
        done on purpose. If people browse the unbuilt version of your documentation
        (e.g. on GitHub or PyPI directly), they'll still be presented with links to the pages
        that contain the information they will need, instead of unhelping directives.
        
        .. Below this line is content specific to GitHub / PyPI that will not appear in the
           built doc.
        .. end-of-index-doc
        
        Check out the built version!
        ============================
        
        This Readme is also built as a Sphinx documentation, and it includes the changelog.
        Interested to see how it looks ? Check it out on `our ReadTheDocs space`_.
        
        .. _`our ReadTheDocs space`: https://sphinx-github-changelog.readthedocs.io/en/stable
        
        If you encounter a bug, or want to get in touch, you're always welcome to open a
        ticket_.
        
        .. _ticket: https://github.com/peopledoc/sphinx-github-changelog/issues/new
        
        Other links
        ===========
        
        - `Code of Conduct <CODE_OF_CONDUCT.rst>`_.
        - `License <LICENCE.rst>`_.
        - `Contributing Guidelines <CONTRIBUTING.rst>`_.
        
Keywords: sphinx,github,changelog
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: lint
Provides-Extra: docs
Provides-Extra: docs_spelling
