Packaging Sprint 2/3 April 2011

Schedule

Start at 9:00am EST on Saturday and Sunday.

Participants

• Kelsey Hightower(Lead) - Atlanta (online) (2/3)
• Elson Rodriguez - Atlanta (online) (2/3)
• Tarek Ziade - Mountain View (online) (3)

You can participate online by joining the #distutils channel on freenode and adding your name above.

Sprint Goals

• remove all distutils2 occurrences and replace them with packaging.

• fix some spelling and grammar errors

• fix Sphinx errors and warnings

• start to re-work the doc that lives outside the packaging folder, that refers to installing/building stuff

• reorganize the doc into sections:

  • end-users
  • developers
  • package managers

Requirements

Clone Tarek's cpython fork from Bitbucket and brush up on reStructuredText and Sphinx.

Hg repository

hg clone https://bitbucket.org/tarek/cpython Most work will take place under the cpython/Doc/packaging/ directory.

Markup and doc generation

Docs are written using reStructuredText markup and auto-generated using Sphinx.

• Sphinx

• reStructuredText

Hosting

Most sprinters will be working remotely, feel free to meetup in small groups and update details here.

Updates

Sprint Report Day 1

Today was pretty productive as we managed to get the docs building without errors or warnings using the cpython method of building the docs.

Major Changes

• Disabled use of the Sphinx autodoc plugin (automodule, autoclass, etc)
  • Seems we cannot use the autodoc plugin without some changes to how we build cpython docs. We mainly need sphinx Python 3 support so features like automodule works.
• Docs have been split up between 3 directories:
  • enduser
  • developer
  • packager
• changed the labels within Doc/packaging/ to use _packaging as a prefix.
  • this was to make it clear we are referencing packaging and not distutils

  • example: .. _metadata => .. _packaging-metadata