Merge pull request #74 from emproof-com/chore/move-docs-to-doc-branch

Change CI to push to cpp-docs branch

.github/workflows/doxygen.yml

@@ -1,4 +1,4 @@
-name: update-docs
+name: docs
 
 on:
   push:
@@ -32,12 +32,11 @@ jobs:
         CI_COMMIT_AUTHOR: update-docs-ci
       # only commit and push changes on the main branch after the mr has been pushed.
       if: github.event_name == 'push'
-      # Force-adds the docs directory, because the docs directory is still in .gitignore
-      # to discourage changing the docs directory in a commit.
       run: |
         git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
         git config --global user.email "[email protected]"
-        git add -f  docs
+        git checkout cpp-docs
+        git add doc
         git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
         git push
 

Doxyfile

@@ -2,5 +2,5 @@ PROJECT_NAME = Nyxstone
 HTML_OUTPUT = ./docs/
 GENERATE_HTML = YES
 GENERATE_LATEX = NO
-INPUT = src include README.md include/tl
+INPUT = src include README.md vendor
 USE_MDFILE_AS_MAINPAGE = README.md

README.md

@@ -3,6 +3,7 @@
 [![Github Cpp CI Badge](https://github.com/emproof-com/nyxstone/actions/workflows/cpp.yml/badge.svg)](https://github.com/emproof-com/nyxstone/actions/workflows/cpp.yml)
 [![crates.io](https://img.shields.io/crates/v/nyxstone.svg)](https://crates.io/crates/nyxstone)
 [![PyPI](https://img.shields.io/pypi/v/nyxstone.svg)](https://pypi.org/project/nyxstone)
+[![cpp-docs](https://github.com/emproof-com/nyxstone/actions/workflows/doxygen.yml/badge.svg)](https://emproof-com.github.io/nyxstone/)
 
 Nyxstone is a powerful assembly and disassembly library based on LLVM. It doesn’t require patches to the LLVM source tree and links against standard LLVM libraries available in most Linux distributions. Implemented as a C++ library, Nyxstone also offers Rust and Python bindings. It supports all official LLVM architectures and allows to configure architecture-specific target settings.