Skip to content

Commit

Permalink
Add documentation types to contributing guide, link to contributing f…
Browse files Browse the repository at this point in the history
…rom README (pypa#485)
  • Loading branch information
Thea Flowers authored May 14, 2018
1 parent 2a15f31 commit c2f869f
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 43 deletions.
55 changes: 12 additions & 43 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,64 +9,33 @@ how to package and install distributions in Python using current tools.
To follow the development of Python packaging, see the `Python
Packaging Authority <https://www.pypa.io>`_.


Code of Conduct
---------------

Everyone interacting in the Python Packaging User Guide project's codebases,
issue trackers, chat rooms, and mailing lists are expected to follow the
`PyPA Code of Conduct`_.

.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/

History
-------

This Guide was forked from the “Hitchhiker's Guide to Packaging” in March 2013,
which was maintained by Tarek Ziadé. Thank you Tarek for all your efforts in
Python packaging.


How to build this guide
-----------------------

In order to build this guide locally, you'll need:

1. `Nox <https://nox.readthedocs.io/en/latest/>`_. You can install or upgrade
nox using ``pip``::

pip install --upgrade nox-automation

2. Python 3.6. Our build scripts are designed to work with Python 3.6 only.
See the `Hitchhiker's Guide to Python installation instructions <http://docs.python-guide.org/en/latest/starting/installation/>`__
to install Python 3.6 on your operating system.

Building the Guide
++++++++++++++++++

To build the guide, run the following bash command in the source folder::

nox -s build

After the process has completed you can find the HTML output in the
``./build/html`` directory. You can open the ``index.html`` file to view the
guide in web browser, but it's recommended to serve the guide using an HTTP
server.

Serving the guide using a local HTTP server
+++++++++++++++++++++++++++++++++++++++++++

You can build the guide and serve it via an HTTP server using the following
command::
Contributing
------------

nox -s preview
This guide is community-maintained and contributions are welcome! Please see the
`contributing guide`_ for details on our writing style guide and how to build
the guide locally to test your changes.

The guide will be browsable via http://localhost:8000.
.. _contributing guide: https://packaging.python.org/contribute

License
-------

The Python Packaging User Guide is licensed under a Creative Commons
Attribution-ShareAlike license: http://creativecommons.org/licenses/by-sa/3.0 .

History
-------

.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
This Guide was forked from the “Hitchhiker's Guide to Packaging” in March 2013,
which was maintained by Tarek Ziadé. Thank you Tarek for all your efforts in
Python packaging.
72 changes: 72 additions & 0 deletions source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,78 @@ other unprofessional conduct is not acceptable.
.. __: https://www.pypa.io/en/latest/code-of-conduct/


Documentation types
===================

This project consists of four distinct documentation types with specific
purposes. When proposing new additions to the project please pick the
appropriate documentation type.

Tutorials
---------

Tutorials are focused on teaching the reader new concepts by accomplishing a
goal. They are opinionated step-by-step guides. They do not include extraneous
warnings or information. `example tutorial-style document`_.

.. _example tutorial-style document: https://docs.djangoproject.com/en/1.11/intro/

Guides
------

Guides are focused on accomplishing a specific task and can assume some level of
pre-requisite knowledge. These are similar to tutorials, but have a narrow and
clear focus and can provide lots of caveats and additional information as
needed. They may also discuss multiple approaches to accomplishing the task.
`example guide-style document`_.

.. _example guide-style document: https://packaging.python.org/namespace_packages/

Discussions
-----------

Discussions are focused on understanding and information. These explore a
specific topic without a specific goal in mind. `example discussion-style
document`_.

.. _example discussion-style document: https://packaging.python.org/requirements/

Building the guide locally
==========================

Though not required to contribute, it may be useful to build this guide locally
in order to test your changes. In order to build this guide locally, you'll
need:

1. `Nox <https://nox.readthedocs.io/en/latest/>`_. You can install or upgrade
nox using ``pip``::

pip install --user nox-automation

2. Python 3.6. Our build scripts are designed to work with Python 3.6 only.
See the `Hitchhiker's Guide to Python installation instructions`_ to install
Python 3.6 on your operating system.

.. _Hitchhiker's Guide to Python installation instructions:
http://docs.python-guide.org/en/latest/starting/installation/

To build the guide, run the following bash command in the source folder::

nox -s build

After the process has completed you can find the HTML output in the
``./build/html`` directory. You can open the ``index.html`` file to view the
guide in web browser, but it's recommended to serve the guide using an HTTP
server.

You can build the guide and serve it via an HTTP server using the following
command::

nox -s preview

The guide will be browsable via http://localhost:8000.


.. _contributing_style_guide:

Style guide
Expand Down

0 comments on commit c2f869f

Please sign in to comment.