Przeglądaj źródła

Updating readme with description of building the documentation, updating github.py module docstring

David Leonard 10 lat temu
rodzic
commit
493183b5b9
2 zmienionych plików z 10 dodań i 1 usunięć
  1. 9 0
      README.md
  2. 1 1
      hackathon_starter/hackathon/scripts/github.py

+ 9 - 0
README.md

@@ -119,6 +119,15 @@ You can also test the project in the browser by doing the following:
 Running `ionic serve` will automatically open up your web browser and run the application.
 
 
+## Building the documentation
+
+In order to build the documentation for this project:
+
+    $ cd hackathon_starter
+    $ make html
+
+The output is stored within `_build/html`. Open up `index.html` to view the documentation.
+
 ## Contributors
 
 * David Leonard

+ 1 - 1
hackathon_starter/hackathon/scripts/github.py

@@ -1,5 +1,5 @@
 '''
-Module github.py contains a handful of methods
+github.py contains a handful of methods
 for interacting with Github data.
 '''