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.

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

Add a skeleton for architecture documentation #6836

Merged
merged 2 commits into from
Aug 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/html/development/architecture/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
===============================
Architecture of pip's internals
===============================

.. note::
This section of the documentation is currently being written. pip
developers welcome your help to complete this documentation. If you're
interested in helping out, please let us know in the `tracking issue`_.

.. note::
Direct use of pip's internals is *not supported*.
For more details, see :ref:`Using pip from your program`.


.. toctree::
:maxdepth: 2



.. _`tracking issue`: https://github.com/pypa/pip/issues/6831
1 change: 1 addition & 0 deletions docs/html/development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ or the `pypa-dev mailing list`_, to ask questions or get involved.

getting-started
contributing
architecture/index
release-process
vendoring-policy

Expand Down