From 9b8af20caf8313c5342eeaef05eaf7cdbcd796d2 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sat, 23 Apr 2011 16:39:37 -0400 Subject: [PATCH] massive refactor --- docs/contents.rst.inc | 42 +++++++++++-------- docs/{ => intro}/community.rst | 0 docs/intro/duction.rst | 14 +++++++ docs/{ => intro}/resources.rst | 0 docs/{ => notes}/contribute.rst | 0 docs/{ => notes}/license.rst | 0 .../ci.rst} | 0 docs/{introduction.rst => scenarios/web.rst} | 0 docs/{ => shipping}/freezing.rst | 0 docs/{ => shipping}/packaging.rst | 0 docs/{ => starting}/dev-env.rst | 0 docs/{ => starting}/installation.rst | 0 docs/starting/next.rst | 0 docs/{ => starting}/which-python.rst | 0 docs/{ => writing}/documentation.rst | 0 .../structure.rst} | 0 docs/{code-style.rst => writing/style.rst} | 0 docs/{testing.rst => writing/tests.rst} | 0 18 files changed, 39 insertions(+), 17 deletions(-) rename docs/{ => intro}/community.rst (100%) create mode 100644 docs/intro/duction.rst rename docs/{ => intro}/resources.rst (100%) rename docs/{ => notes}/contribute.rst (100%) rename docs/{ => notes}/license.rst (100%) rename docs/{getting-started-next.rst => scenarios/ci.rst} (100%) rename docs/{introduction.rst => scenarios/web.rst} (100%) rename docs/{ => shipping}/freezing.rst (100%) rename docs/{ => shipping}/packaging.rst (100%) rename docs/{ => starting}/dev-env.rst (100%) rename docs/{ => starting}/installation.rst (100%) create mode 100644 docs/starting/next.rst rename docs/{ => starting}/which-python.rst (100%) rename docs/{ => writing}/documentation.rst (100%) rename docs/{project-structure.rst => writing/structure.rst} (100%) rename docs/{code-style.rst => writing/style.rst} (100%) rename docs/{testing.rst => writing/tests.rst} (100%) diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc index 1f3fa72..909479b 100644 --- a/docs/contents.rst.inc +++ b/docs/contents.rst.inc @@ -7,9 +7,9 @@ background information about Python, then focuses on next steps. .. toctree:: :maxdepth: 2 - introduction - community - resources + intro/duction + intro/community + intro/resources Getting Started @@ -20,10 +20,10 @@ This part of the guide focuses on setting up your Python environment. .. toctree:: :maxdepth: 2 - which-python - installation - dev-env - getting-started-next + starting/which-python + starting/installation + starting/dev-env + starting/next Writing Great Code @@ -34,11 +34,10 @@ This part of the guide focuses on best practices for writing Python code. .. toctree:: :maxdepth: 2 - project-structure - code-style - documentation - testing - packaging + writing/structure + writing/style + starting/documentation + starting/tests @@ -50,13 +49,22 @@ This part of the guide focuses on deploying your Python code. .. toctree:: :maxdepth: 2 - project-structure - documentation - testing - packaging - freezing + shipping/packaging + shipping/freezing +Scenario Guide +-------------- + +This part of the guide focuses on tool and module advice based on +different scenarios. + +.. toctree:: + :maxdepth: 2 + + scenarios/web + scenarios/ci + Additional Notes ---------------- diff --git a/docs/community.rst b/docs/intro/community.rst similarity index 100% rename from docs/community.rst rename to docs/intro/community.rst diff --git a/docs/intro/duction.rst b/docs/intro/duction.rst new file mode 100644 index 0000000..55b2ff2 --- /dev/null +++ b/docs/intro/duction.rst @@ -0,0 +1,14 @@ +Introduction +============ + + +Idioms +:::::: + + +Zen of Python +------------- + + +PEP-8 +----- \ No newline at end of file diff --git a/docs/resources.rst b/docs/intro/resources.rst similarity index 100% rename from docs/resources.rst rename to docs/intro/resources.rst diff --git a/docs/contribute.rst b/docs/notes/contribute.rst similarity index 100% rename from docs/contribute.rst rename to docs/notes/contribute.rst diff --git a/docs/license.rst b/docs/notes/license.rst similarity index 100% rename from docs/license.rst rename to docs/notes/license.rst diff --git a/docs/getting-started-next.rst b/docs/scenarios/ci.rst similarity index 100% rename from docs/getting-started-next.rst rename to docs/scenarios/ci.rst diff --git a/docs/introduction.rst b/docs/scenarios/web.rst similarity index 100% rename from docs/introduction.rst rename to docs/scenarios/web.rst diff --git a/docs/freezing.rst b/docs/shipping/freezing.rst similarity index 100% rename from docs/freezing.rst rename to docs/shipping/freezing.rst diff --git a/docs/packaging.rst b/docs/shipping/packaging.rst similarity index 100% rename from docs/packaging.rst rename to docs/shipping/packaging.rst diff --git a/docs/dev-env.rst b/docs/starting/dev-env.rst similarity index 100% rename from docs/dev-env.rst rename to docs/starting/dev-env.rst diff --git a/docs/installation.rst b/docs/starting/installation.rst similarity index 100% rename from docs/installation.rst rename to docs/starting/installation.rst diff --git a/docs/starting/next.rst b/docs/starting/next.rst new file mode 100644 index 0000000..e69de29 diff --git a/docs/which-python.rst b/docs/starting/which-python.rst similarity index 100% rename from docs/which-python.rst rename to docs/starting/which-python.rst diff --git a/docs/documentation.rst b/docs/writing/documentation.rst similarity index 100% rename from docs/documentation.rst rename to docs/writing/documentation.rst diff --git a/docs/project-structure.rst b/docs/writing/structure.rst similarity index 100% rename from docs/project-structure.rst rename to docs/writing/structure.rst diff --git a/docs/code-style.rst b/docs/writing/style.rst similarity index 100% rename from docs/code-style.rst rename to docs/writing/style.rst diff --git a/docs/testing.rst b/docs/writing/tests.rst similarity index 100% rename from docs/testing.rst rename to docs/writing/tests.rst