HTML documentation

Author: SebastienRietteMTO

.github/workflows/doxygen.yaml

@@ -0,0 +1,33 @@
+name: Doxygen
+run-name: Updating online doc
+on:
+  push:
+    branches:
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: "true"
+
+      - name: Install Doxygen
+        run: sudo apt-get install doxygen graphviz -y
+        shell: bash
+
+      - name: Generate Doxygen Documentation
+        run: cd docs; ./build_doc.sh
+        shell: bash
+
+      - name: Create .nojekyll (ensures pages with underscores work on gh pages)
+        run: touch docs/html/.nojekyll
+        shell: bash
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs/html
+

.gitignore

@@ -1,2 +1,4 @@
 src/gitgraphz.egg-info
 src/gitgraphz/__pycache__
+docs/html
+*.swp

README.md

@@ -1,4 +1,4 @@
-# git-graph
+# git-graphz
 
 Tool to create a graph from a git history showing tags, branches, stash nodes, cherry-picks.
 
@@ -11,27 +11,31 @@ Tool to create a graph from a git history showing tags, branches, stash nodes, c
 
 Run the following inside a git directory to write a graph description (DOT format) to stdout.
 
-    ./git-graph
+    git-graphz
 
 On linux you can use the following command to create a graph.ps file
 
-    ./git-graph | dot -Tps -o graph.ps
+    git-graphz | dot -Tps -o graph.ps
 
 Or you can simply (the file extension must be an accepted command line option of the dot utility (see [here](https://www.graphviz.org/docs/outputs/))
 
-    ./git-graph -o image.pdf
+    git-graphz -o image.pdf
 
 In addition to the graphviz accepted extensions, it is also possible to generate an html page
 
-    ./git-graph -o image.html
+    git-graphz -o image.html
 
 Example with range
 
-    ./git-graph -r a51eced..HEAD | dot -Tps -o graph.ps
+    git-graphz -r a51eced..HEAD | dot -Tps -o graph.ps
 
 Example with upstream commits
 
-    ./git-graph --option=--remotes=upstream
+    git-graphz --option=--remotes=upstream
+
+You can also provide an url for the git repository (instead of running the command in a git directory)
+
+    git-graphz -p https://github.com/SebastienRietteMTO/git-graphz.git
 
 ### Parameters
 * **-v**: to print info (or debug if provided twice) output to stderr
@@ -40,5 +44,5 @@ Example with upstream commits
 * **-p path**: to specify the directory containig the git repository (current working directory if omitted) or the url of a git repository
 * **--option=OPTION**: to add an option to the git log command used to list the relevant commits. If no option is provided the '--all' option is used. Ex: --option=--remotes=upstream
 
-# Example Graph
-![alt text](images/example.gif)
+# Example Graphs
+![simple example](docs/example.gif)