Rename links to .html files in the documentation to .rst.

jaragunde · jaragunde · commit 45a331e0b10e · 2016-03-29T21:01:23.000+02:00
With this change, the documentation can be browsed directly from GitHub
repo UI. The .rst links will be renamed to .html when the help files
are generated by the Makefile.
diff --git a/Makefile b/Makefile
@@ -21,8 +21,9 @@ help:
 	date >> footer; \
 	#parse rst
 	for i in `find -name *.rst` ; do \
+	  #rename .rst for .html in links to other doc pages \
+	  sed 's/.rst/.html/g' $$i > tmp; \
 	  #append footer \
-	  cat $$i > tmp; \
 	  cat footer >> tmp; \
 	  #extract file name to be used as the output file name \
 	  FILE=`echo $$i | awk '{firstpart=substr($$i, 8);x=index(firstpart,".rst");print substr(firstpart, 1,x)}'`; \
diff --git a/docs/admin/index.rst b/docs/admin/index.rst
@@ -6,7 +6,7 @@ PhpReport is a web application for time tracking, which provides useful
 statistics about users, projects, and more. These documents provide the basic
 concepts to install and configure PhpReport for system administrators.
 
-#. `Installation instructions <installation.html>`__
-#. `Upgrade instructions <upgrade.html>`__
-#. `How to set up LDAP authentication <ldap.html>`__
-#. `Common problems <common-problems.html>`__
+#. `Installation instructions <installation.rst>`__
+#. `Upgrade instructions <upgrade.rst>`__
+#. `How to set up LDAP authentication <ldap.rst>`__
+#. `Common problems <common-problems.rst>`__
diff --git a/docs/admin/installation.rst b/docs/admin/installation.rst
@@ -148,5 +148,5 @@ change it::
   define ('YEARLY_HOLIDAY_HOURS', 184);
 
 Remember to check the `data model for holiday management
-<../user/overview.html#data-model-for-holiday-management>`__ to know how it
+<../user/overview.rst#data-model-for-holiday-management>`__ to know how it
 works and which value you should put there.
diff --git a/docs/admin/upgrade.rst b/docs/admin/upgrade.rst
@@ -60,7 +60,7 @@ not guaranteed. For these reasons, you will have to install PhpReport 2.0 in a
 new location and create a new DB for it which needs to be available side by side
 with PhpReport 1.x database during the migration.
 
-Begin following the `installation instructions <installation.html>`__ from steps
+Begin following the `installation instructions <installation.rst>`__ from steps
 0 to 2. Take into account you will probably have to use a different name for the
 DB and extract the files to a different directory to avoid conflicts with the
 existing installation. At step 3 you must follow the manual setup instructions,
diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -6,53 +6,53 @@ PhpReport is a web application for time tracking, which provides useful
 statistics about users, projects, and more. These documents provide the basic
 concepts to use PhpReport both for worker and manager profiles.
 
-#. `Overview <overview.html>`__
-#. `Tasks management <tasks.html>`__
+#. `Overview <overview.rst>`__
+#. `Tasks management <tasks.rst>`__
 
-   * `The tasks management screen <tasks.html#the-tasks-management-screen>`__
-   * `Managing tasks <tasks.html#managing-tasks>`__
-   * `Using templates <tasks.html#using-templates>`__
-   * `Copying tasks from another date <tasks.html#copying-tasks-from-another-date>`__
-   * `Blocked tasks <tasks.html#blocked-tasks>`__
-   * `Hotkeys <tasks.html#hotkeys>`__
+   * `The tasks management screen <tasks.rst#the-tasks-management-screen>`__
+   * `Managing tasks <tasks.rst#managing-tasks>`__
+   * `Using templates <tasks.rst#using-templates>`__
+   * `Copying tasks from another date <tasks.rst#copying-tasks-from-another-date>`__
+   * `Blocked tasks <tasks.rst#blocked-tasks>`__
+   * `Hotkeys <tasks.rst#hotkeys>`__
 
-#. `Reports <reports.html>`__
+#. `Reports <reports.rst>`__
 
-   * `User tasks <reports.html#user-tasks>`__
-   * `User details <reports.html#user-details>`__
-   * `User evaluation <reports.html#user-evaluation>`__
-   * `Accumulated hours <reports.html#accumulated-hours>`__
-   * `Project evaluation <reports.html#project-evaluation>`__
-   * `Project details <reports.html#project-details>`__
-   * `Projects summary <reports.html#projects-summary>`__
+   * `User tasks <reports.rst#user-tasks>`__
+   * `User details <reports.rst#user-details>`__
+   * `User evaluation <reports.rst#user-evaluation>`__
+   * `Accumulated hours <reports.rst#accumulated-hours>`__
+   * `Project evaluation <reports.rst#project-evaluation>`__
+   * `Project details <reports.rst#project-details>`__
+   * `Projects summary <reports.rst#projects-summary>`__
 
-#. `Projects management <projects-management.html>`__
+#. `Projects management <projects-management.rst>`__
 
-   * `Create, edit and delete projects <projects-management.html#create-edit-and-delete-projects>`__
-   * `Assigning clients <projects-management.html#assigning-clients>`__
-   * `Assigning users <projects-management.html#assigning-users>`__
+   * `Create, edit and delete projects <projects-management.rst#create-edit-and-delete-projects>`__
+   * `Assigning clients <projects-management.rst#assigning-clients>`__
+   * `Assigning users <projects-management.rst#assigning-users>`__
 
-#. `Users management <users-management.html>`__
+#. `Users management <users-management.rst>`__
 
-   * `Create, edit and delete users <users-management.html#create-edit-and-delete-users>`__
-   * `Setting the hour cost for a user <users-management.html#setting-the-hour-cost-for-a-user>`__
-   * `Setting the journey for a user <users-management.html#setting-the-journey-for-a-user>`__
-   * `Setting the area for a user <users-management.html#setting-the-area-for-a-user>`__
-   * `Setting the city for a user <users-management.html#setting-the-city-for-a-user>`__
+   * `Create, edit and delete users <users-management.rst#create-edit-and-delete-users>`__
+   * `Setting the hour cost for a user <users-management.rst#setting-the-hour-cost-for-a-user>`__
+   * `Setting the journey for a user <users-management.rst#setting-the-journey-for-a-user>`__
+   * `Setting the area for a user <users-management.rst#setting-the-area-for-a-user>`__
+   * `Setting the city for a user <users-management.rst#setting-the-city-for-a-user>`__
 
-#. `Clients management <clients-management.html>`__
+#. `Clients management <clients-management.rst>`__
 
-   * `Create, edit and delete clients <clients-management.html#create-edit-and-delete-clients>`__
-   * `Create, edit and delete sectors <clients-management.html#create-edit-and-delete-sectors>`__
+   * `Create, edit and delete clients <clients-management.rst#create-edit-and-delete-clients>`__
+   * `Create, edit and delete sectors <clients-management.rst#create-edit-and-delete-sectors>`__
 
-#. `Cities and work calendars management <cities-calendars-management.html>`__
+#. `Cities and work calendars management <cities-calendars-management.rst>`__
 
-   * `Create, edit and delete cities <cities-calendars-management.html#create-edit-and-delete-cities>`__
-   * `Work calendars management <cities-calendars-management.html#work-calendars-management>`__
+   * `Create, edit and delete cities <cities-calendars-management.rst#create-edit-and-delete-cities>`__
+   * `Work calendars management <cities-calendars-management.rst#work-calendars-management>`__
 
-#. `Management of other entities <other-management.html>`__
+#. `Management of other entities <other-management.rst>`__
 
-   * `Create, edit and delete areas <other-management.html#create-edit-and-delete-areas>`__
-   * `Create, edit and delete extra hours compensations <other-management.html#create-edit-and-delete-extra-hours-compensations>`__
+   * `Create, edit and delete areas <other-management.rst#create-edit-and-delete-areas>`__
+   * `Create, edit and delete extra hours compensations <other-management.rst#create-edit-and-delete-extra-hours-compensations>`__
 
-#. `Application settings <settings-management.html>`__
+#. `Application settings <settings-management.rst>`__
diff --git a/docs/user/projects-management.rst b/docs/user/projects-management.rst
@@ -73,7 +73,7 @@ you won't be allowed to delete it. You have to remove those assignations and try
 the deletion later.
 
 Finally, the last button, *Details*, will open the
-`project details report <reports.html#project-details>`__ for the selected
+`project details report <reports.rst#project-details>`__ for the selected
 project.
 
 Assigning clients
diff --git a/docs/user/reports.rst b/docs/user/reports.rst
@@ -146,7 +146,7 @@ represent users and columns represent the following data:
 Pending holiday hours:
   it's the difference between the theoretical number of
   holiday hours for every user (calculated according to the explanation in
-  `Data model for holiday management <overview.html#data-model-for-holiday-management>`__)
+  `Data model for holiday management <overview.rst#data-model-for-holiday-management>`__)
   and the number of holiday hours used. The unused holidays are accumulated from
   one year to the next one; to see only the number of pending holidays in the
   current year, a start date in the current year must be chosen.
diff --git a/docs/user/users-management.rst b/docs/user/users-management.rst
@@ -84,7 +84,7 @@ The journey is the number of hours the person is supposed to work for every
 working day. Working days in PhpReport are Monday to Friday. This value will be
 used to calculate the balance of *Extra hours* for a user, as well as the
 corresponding amount of *Holiday hours*. These values can be checked in the
-`Accumulated hours <reports.html#accumulated-hours>`__ report.
+`Accumulated hours <reports.rst#accumulated-hours>`__ report.
 
 This value may vary with time (e.g. a user may change from full time to part-time
 dedication for a specific period of time), so you will have to enter an *Init date* and
