diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index fa66a8f..d2f9690 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,9 +1,7 @@ name: Docs on: - #push: - # branches-ignore: - # - '**' + workflow_dispatch: push: branches: [ master ] pull_request: @@ -11,26 +9,26 @@ on: jobs: build: - - runs-on: macos-latest - + runs-on: ubuntu-latest + permissions: + contents: write steps: - - name: Install Requirements - run: brew install doxygen - && brew install sphinx-doc - && pip3 install sphinx-rtd-theme - && pip3 install breathe - && pip3 install sphinx-sitemap - name: Checkout Repo - uses: actions/checkout@1.0.0 - - name: Build Docs - run: cd docs - && make html - && cd temp_build/html - && touch .nojekyll + uses: actions/checkout@v4 + - name: Install Python + uses: actions/setup-python@v3 + - name: Install Doxygen + uses: ssciwr/doxygen-install@v1 + - name: Install Dependencies + run: | + pip install sphinx sphinx_rtd_theme sphinx-sitemap breathe docutils + - name: Sphinx Build + run: | + cd docs + make html + cd temp_build/html + touch .nojekyll - name: Deploy - uses: JamesIves/github-pages-deploy-action@releases/v3 + uses: JamesIves/github-pages-deploy-action@v4 with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages # The branch the action should deploy to. - FOLDER: docs/temp_build/html # The folder the action should deploy. \ No newline at end of file + folder: docs/temp_build/html # The folder the action should deploy \ No newline at end of file diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 1727dc3..1638db5 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -38,7 +38,7 @@ PROJECT_NAME = strutil # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.0.2 +PROJECT_NUMBER = 2.0.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/docs/Makefile b/docs/Makefile index d97a551..8e89358 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,8 +2,8 @@ # # You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = temp_build diff --git a/docs/conf.py b/docs/conf.py index 3724ae8..24cb6e0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ author = u'Tomasz Gałaj' # The short X.Y version -version = u'' +version = u'2.0' # The full version, including alpha/beta/rc tags release = u'' @@ -228,7 +228,7 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} # -- Options for todo extension ---------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 98f74f2..0e22c1c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ strutil ======= -Easy to use, header only C++ 17 std::string utility library. +Easy to use, header only C++ 20 std::string utility library. Any constructive comments and improvements to this little library are more than welcome. diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..ea1a1d6 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +breathe>=4.29.0 +sphinx>=6.1.3 +docutils>=0.19 +sphinx_rtd_theme +sphinx-sitemap \ No newline at end of file