Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation rewrite (Q1 2021) #9474

Closed
wants to merge 32 commits into from
Closed

Documentation rewrite (Q1 2021) #9474

wants to merge 32 commits into from

Commits on Feb 28, 2021

  1. Enable MyST in documentation

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    5a2de5b View commit details
    Browse the repository at this point in the history

  2. Remove the docs-feedback extension

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    0998b3d View commit details
    Browse the repository at this point in the history

  3. Add new documentation skeleton

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    ac2c98a View commit details
    Browse the repository at this point in the history

  4. Drop old .rst files overlapping with new skeleton

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    7b1b87c View commit details
    Browse the repository at this point in the history

  5. Rewrite docs/conf.py 

    This simplifies the Sphinx configuration and adds additional grouping
and structure to the existing code as well.
    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    c61ebed View commit details
    Browse the repository at this point in the history

  6. Add configuration for MyST

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    4915115 View commit details
    Browse the repository at this point in the history

  7. Add .md files in docs/ to MANIFEST

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    54e20ef View commit details
    Browse the repository at this point in the history

  8. Add autodoc and todo plugins for Sphinx

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    09ee251 View commit details
    Browse the repository at this point in the history

  9. Move CLI docs into cli/ and write new index page

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    79614e3 View commit details
    Browse the repository at this point in the history

  10. Change news to Markdown 

    Use eval-rst, for directives that don't support MyST yet.
    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    3c3967c View commit details
    Browse the repository at this point in the history

  11. Add sphinx-copybutton

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    3d159ca View commit details
    Browse the repository at this point in the history

  12. Populate the new Getting Started page

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    f57c248 View commit details
    Browse the repository at this point in the history

  13. Point to the PyPUG tutorial from quickstart

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    f808256 View commit details
    Browse the repository at this point in the history

  14. Blacken pip_sphinxext.py

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    937a74d View commit details
    Browse the repository at this point in the history

  15. Add a pip-cli directive for MyST

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    5e6e37e View commit details
    Browse the repository at this point in the history

  16. Enable black on docs/

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    e89328d View commit details
    Browse the repository at this point in the history

  17. Add dedicated page for authentication

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    0b959be View commit details
    Browse the repository at this point in the history

  18. Add dedicated page for Caching 

    This page still needs a bit of expanding, to elaborate further on
using `pip cache` to manage pip's cache.
    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    26b21ab View commit details
    Browse the repository at this point in the history

  19. Add dedicated page for Configuration

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    57c166e View commit details
    Browse the repository at this point in the history

  20. Add dedicated page for editable installs

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    8094e23 View commit details
    Browse the repository at this point in the history

  21. Add dedicated page for Repeatable Installs

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    e0693a7 View commit details
    Browse the repository at this point in the history

  22. Add dedicated page for Requirements Files

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    de0d794 View commit details
    Browse the repository at this point in the history

  23. Add dedicated page for User Installs

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    e899320 View commit details
    Browse the repository at this point in the history

  24. Add dedicated page for VCS support

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    001fb46 View commit details
    Browse the repository at this point in the history

  25. Add dedicated page for Requirements File format

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    b8fa4b9 View commit details
    Browse the repository at this point in the history

  26. Add a docs-live nox session

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    4e400ee View commit details
    Browse the repository at this point in the history

  27. Add explanation page for custom install options

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    01305a5 View commit details
    Browse the repository at this point in the history

  28. Capitalise all headings

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    4b0712e View commit details
    Browse the repository at this point in the history

  29. Add dedicated page on how configuration works

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    96cbeaf View commit details
    Browse the repository at this point in the history

  30. 📰

    @pradyunsg
    pradyunsg committed Feb 28, 2021
    Configuration menu
    Copy the full SHA
    a339fb1 View commit details
    Browse the repository at this point in the history

Commits on Mar 3, 2021

  1. Tweak sentence in authentication explainer

    @pradyunsg
    pradyunsg committed Mar 3, 2021
    Configuration menu
    Copy the full SHA
    7c3af23 View commit details
    Browse the repository at this point in the history

  2. Move compatibility information to getting-started

    @pradyunsg
    pradyunsg committed Mar 3, 2021
    Configuration menu
    Copy the full SHA
    8b4d927 View commit details
    Browse the repository at this point in the history