From ceb188026f520f5fedc4b3cadc387e0dacf319b7 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Mon, 3 Sep 2012 04:28:36 -0400 Subject: [PATCH] explanation --- docs/_templates/sidebarintro.html | 2 +- docs/_templates/sidebarlogo.html | 3 ++- docs/_themes/kr/static/flasky.css_t | 3 +++ docs/appendix.rst | 0 docs/contents.rst.inc | 27 ++++++++++++++++++++++++--- docs/index.rst | 7 ++----- 6 files changed, 32 insertions(+), 10 deletions(-) create mode 100644 docs/appendix.rst diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html index e29e37d..0ebccbb 100644 --- a/docs/_templates/sidebarintro.html +++ b/docs/_templates/sidebarintro.html @@ -1,4 +1,4 @@ -

Conduct of Code.

+

This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.

diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html index d7f12de..eb1a090 100644 --- a/docs/_templates/sidebarlogo.html +++ b/docs/_templates/sidebarlogo.html @@ -1,4 +1,5 @@ -

Python Guide.

+

Conduct of Code.

+

This opinionated guide exists to provide both novice and expert Python developers a best-practice handbook to the installation, configuration, and usage of Python on a daily basis.

diff --git a/docs/_themes/kr/static/flasky.css_t b/docs/_themes/kr/static/flasky.css_t index c86b80b..e7ec6b4 100644 --- a/docs/_themes/kr/static/flasky.css_t +++ b/docs/_themes/kr/static/flasky.css_t @@ -95,6 +95,9 @@ div.sphinxsidebarwrapper p.logo { margin: -10px 0 0 -20px; text-align: center; } +div.sphinxsidebarwrapper h1 { + font-size: 25px; +} div.sphinxsidebar h3, div.sphinxsidebar h4 { diff --git a/docs/appendix.rst b/docs/appendix.rst new file mode 100644 index 0000000..e69de29 diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc index 2c74c75..5dddc3c 100644 --- a/docs/contents.rst.inc +++ b/docs/contents.rst.inc @@ -1,7 +1,9 @@ Act I: Id --------- -This part of the guide focuses on... +*Id* is the set of uncoordinated instinctual trends in the human psyche. + +This part of the guide focuses on the philosophy behind great code. .. toctree:: :maxdepth: 2 @@ -15,7 +17,9 @@ This part of the guide focuses on... Act II: Ego ----------- -This part of the guide focuses on best practices for writing code. +*Ego* is the organized and realistic role of the human psyche. + +This part of the guide focuses on best practices for organizing and writing code. - obvious benefit (constraints foster creativity) - lawyer up @@ -26,6 +30,10 @@ This part of the guide focuses on best practices for writing code. Act III: Super-ego ------------------ +*Super-ego* is the critical and moralizing role of the human psyche. + +This part of the guide focuses on the ethos of great code communities. + - Clarity is Key - Documentation - Community @@ -33,7 +41,20 @@ Act III: Super-ego - Code of Conduct --------------------------------------- +-------------------- + + +Appendix A: Resources +--------------------- + +For further reading... + +- Semantic Versioning +- The Architecture of Open Source Applications +- *&c* + +Appendix B: Meta +---------------- Contibution notes and legal information are here (for those interested). diff --git a/docs/index.rst b/docs/index.rst index 6af1957..c7e12d7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -The Conduct of Code -=================== +Conduct of Code, *a Manifesto*. +=============================== In our busy lives, we have to take time to reflect. It's easy to forget why we code. @@ -12,7 +12,4 @@ Great code is craft — a reflection of the person creating it. Let's focus on why. - - - .. include:: contents.rst.inc \ No newline at end of file