Clean the code.

chevah · Sep 14, 2017 · 32d4acb · 32d4acb
1 parent c781281
commit 32d4acb
Show file tree

Hide file tree

Showing 20 changed files with 16 additions and 52 deletions.
diff --git a/Makefile b/Makefile
@@ -20,5 +20,11 @@ env:
 generate:
 	build/venv/bin/sphinx-build -b html -j 2 -n docs/ build/html
 
+test:
+	rm -f build/errors
+	build/venv/bin/sphinx-build -b html -Ean -j 2 -w build/errors \
+		docs/ build/html
+	if [ -s build/errors ]; then false ; fi
+
 clean:
 	@rm -rf build
diff --git a/docs/bash.rst b/docs/bash.rst
@@ -1,8 +1,6 @@
 Bash
 ####
 
-:menu_order: 016
-
 ..  contents::
 
 

diff --git a/docs/css.rst b/docs/css.rst
@@ -1,9 +1,6 @@
 CSS, LESS and Styles
 ####################
 
-:menu_order: 014
-:slug: css
-
 .. contents::
 
 

diff --git a/docs/defects-tech-debt.rst b/docs/defects-tech-debt.rst
@@ -1,8 +1,6 @@
 Bugs and Tech-Debt
 ##################
 
-:menu_order: 004
-
 .. contents::
 
 

diff --git a/docs/dependencies.rst b/docs/dependencies.rst
@@ -1,8 +1,6 @@
 Dependencies
 ############
 
-:menu_order: 017
-
 .. contents::
 
 

diff --git a/docs/documentation.rst b/docs/documentation.rst
@@ -1,8 +1,6 @@
 Documentation
 #############
 
-:menu_order: 007
-
 .. contents::
 
 

diff --git a/docs/generic.rst b/docs/generic.rst
@@ -1,8 +1,6 @@
 Generic
 #######
 
-:menu_order: 001
-
 ..  contents::
 
 General

diff --git a/docs/html.rst b/docs/html.rst
@@ -1,9 +1,6 @@
 HTML, XML and other markups
 ###########################
 
-:menu_order: 015
-:slug: html
-
 .. contents::
 
 

diff --git a/docs/javascript.rst b/docs/javascript.rst
@@ -1,8 +1,6 @@
 JavaScript
 ##########
 
-:menu_order: 013
-
 .. contents::
 
 General
@@ -143,7 +141,7 @@ Example::
 
     In HTML, we use " as quotes around attribute values, like this:
 
-.. sourcecode:: javascript
+.. sourcecode:: html
 
     <a href="foo">bar</a>
     In JavaScript, we use ' as much as possible.

diff --git a/docs/leave.rst b/docs/leave.rst
@@ -1,8 +1,6 @@
 Leave / Holiday
 ###############
 
-:menu_order: 010
-
 General
 =======
 

diff --git a/docs/library.rst b/docs/library.rst
@@ -1,8 +1,6 @@
 Library
 #######
 
-:menu_order: 011
-
 These page contains list of pages talking about life, programming craftsmanship,
 good/clean code, and much more. 
 The list is in random order:

diff --git a/docs/onboarding.rst b/docs/onboarding.rst
@@ -1,10 +1,6 @@
 Onboarding
 ##########
 
-:menu_order: 1
-:url: /onboarding.html
-:save_as: onboarding.html
-
 This page is used to organize tasks and track the onboarding process for new members.
 You can see past/active tasks in the `onboarding repo <hhttps://github.com/chevah/onboarding/>`_.
 
@@ -84,14 +80,14 @@ Ask the tech lead for any questions.
 * Take note of the `coding conventions <http://styleguide.chevah.com>`_ applied for this project. These general coding conventions are for all 'texts' (code, documentation, etc). 
 
 * There are specific rules that apply to programming languages. Begin by reading the general `coding conventions <http://styleguide.chevah.com>`_.
-Then review each language specific convention as you will be writing in that language.
+  Then review each language specific convention as you will be writing in that language.
 
 * While you are in IRC on #chevah "in the office", set to auto-away to let others know that you are not at the computer. Set the away status to "busy" (/away busy) if you are working at something and don't want to be disturbed.
 
 * You will use your own hardware for work tasks.
-To compensate for this usage of your hardware we will cover hardware expenses for your home computer.
-If you need a hardware component or peripheral that will help your work related tasks, ask and we can cover those expenses.
-Ask tech lead for details.
+  To compensate for this usage of your hardware we will cover hardware expenses for your home computer.
+  If you need a hardware component or peripheral that will help your work related tasks, ask and we can cover those expenses.
+  Ask tech lead for details.
 
 * Each task that you are working on should have a ticket in Trac/Github. If there is no ticket, create one and start the `Ticket Work Flow <http://styleguide.chevah.com/tickets.html>`_. 
 
@@ -106,12 +102,12 @@ Ask tech lead for details.
 * From time to time, check the Trac timeline to stay up to date with latest changes in the project.
 
 * When starting a support ticket, request the OS version architecture used and version of the SFTPPlus products.
-Further details in Trac.
+  Further details in Trac.
 
 * Before a Pull Request is closed, it must be reviewed by at least one other team member. Further info of the `Review process <http://styleguide.chevah.com/review.html>`_.
 
 * Leave days can be requested at any time.
-Check the dedicated page in Trac.
+  Check the dedicated page in Trac.
 
 * Add your preferred email address in Trac ( Preferences -> General ) to enable email notifications.
 
@@ -145,9 +141,9 @@ Use the dedicated ProAtria Skype account as the official tools to collaborate wi
 * Request for VPN certificates to connect to internal servers/services.
 
 * You will need a Trac account setup.
-Trac tickets are used for managing work items since there is no support with the web-based GitHub issue/task/defect management
-Trac also contains wiki pages to other documentation.
-Get to know the team by checking the dedicated page in our private wiki.
+  Trac tickets are used for managing work items since there is no support with the web-based GitHub issue/task/defect management
+  Trac also contains wiki pages to other documentation.
+  Get to know the team by checking the dedicated page in our private wiki.
 
 
 4. Exploring SFTPPlus for the first time

diff --git a/docs/python.rst b/docs/python.rst
@@ -1,8 +1,6 @@
 Python
 ######
 
-:menu_order: 012
-
 .. contents::
 
 

diff --git a/docs/references.rst b/docs/references.rst
@@ -1,8 +1,6 @@
 References
 ##########
 
-:menu_order: 016
-
 .. contents::
 
 These page contains a list of sources used for creating this content.

diff --git a/docs/release.rst b/docs/release.rst
@@ -1,8 +1,6 @@
 Release process
 ###############
 
-:menu_order: 006
-
 ..  contents::
 
 

diff --git a/docs/review.rst b/docs/review.rst
@@ -1,8 +1,6 @@
 Review
 ######
 
-:menu_order: 003
-
 This page will discuss the code/changes review process as both the person
 who requests a review and a person who checks the review.
 The review instructions are platform independent so they apply to tickets,

diff --git a/docs/security.rst b/docs/security.rst
@@ -1,8 +1,6 @@
 Security
 ########
 
-:menu_order: 009
-
 .. contents::
 
 

diff --git a/docs/testing.rst b/docs/testing.rst
@@ -1,8 +1,6 @@
 Testing
 #######
 
-:menu_order: 002
-
 .. contents::
 
 Writing automated tests is an important part of development.

diff --git a/docs/tickets.rst b/docs/tickets.rst
@@ -1,8 +1,6 @@
 Tickets
 #######
 
-:menu_order: 005
-
 .. contents::
 
 

diff --git a/docs/work.rst b/docs/work.rst
@@ -1,8 +1,6 @@
 Work
 ####
 
-:menu_order: 008
-
 .. contents::
 
 General