Differences between revisions 1 and 13 (spanning 12 versions)
Revision 1 as of 2011-03-30 02:23:51
Size: 699
Editor: c-98-252-134-52
Comment:
Revision 13 as of 2011-04-03 05:38:28
Size: 2166
Editor: c-98-252-134-52
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
== Schedule ==

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

 Add your name:
Line 7: Line 9:
 * Kelsey Hightower - Atlanta (online) (2/3)
 
 * Kelsey Hightower(Lead) - Atlanta (online) (2/3)
 * Elson Rodriguez - Atlanta (online) (2/3)
 * Tarek Ziade - Mountain View (online) (3)
Line 11: Line 14:
You can participate online by joining the #distutils channel on the [[http://freenode.net/|freenode irc networks]] You can participate online by joining the #distutils channel on [[http://freenode.net/|freenode]] and adding your name above.
Line 16: Line 19:
 * remove all distutils2 occurrences and replace them with packaging.  * (./) remove all distutils2 occurrences and replace them with packaging.
 * fix some spelling and grammar errors
 * (./) fix Sphinx errors and warnings
Line 18: Line 23:
 * reorganize the doc into sections:
   * for end-user
   * for developers
   * for package managers
 * (./) reorganize the doc into sections:
   * end-users
   * developers
   * package managers
Line 25: Line 30:
Clone Tarek's cpython fork from Bitbucket. Clone Tarek's cpython fork from Bitbucket and brush up on reStructuredText and Sphinx.

=== Hg repository ===
Line 28: Line 35:
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.
 * [[http://sphinx.pocoo.org/| Sphinx]]
 * [[http://docutils.sourceforge.net/rst.html| reStructuredText]]
Line 31: Line 45:

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

== Sprint Report Day 1 (April 2, 2011) ==

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 python3 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)

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.

Hosting

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

== Sprint Report Day 1 (April 2, 2011) ==

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 python3 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)

Packaging/Sprints/DocumentationSprint (last edited 2011-04-03 23:08:23 by c-98-252-134-52)

Unable to edit the page? See the FrontPage for instructions.