diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml index 3d1fc8ea2e..8cd9de8b91 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-pages.yml @@ -36,7 +36,7 @@ jobs: ZOTERO_TOKEN: ${{secrets.ZOTERO_TOKEN}} ZOTERO_GROUP: 2380941 run: | - python scripts/generate-pubs.py -g $ZOTERO_GROUP -o publications.md + python scripts/generate-pubs.py -g $ZOTERO_GROUP echo "DIFF_COUNT=$(git diff -- publications.md | wc -l)" >> $GITHUB_OUTPUT - name: Push updated publications if: ${{steps.update.outcome != 'failure' diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 86081e51fc..7974ef8b01 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -27,7 +27,7 @@ jobs: - name: Check out Celeritas uses: actions/checkout@v4 with: - fetch-depth: 255 + fetch-depth: 383 fetch-tags: true - name: Configure celeritas # Turn warnings into errors only for PRs @@ -71,7 +71,7 @@ jobs: - name: Check out Celeritas uses: actions/checkout@v4 with: - fetch-depth: 255 + fetch-depth: 383 fetch-tags: true - name: Install Python packages run: | diff --git a/doc/appendix/administration.rst b/doc/appendix/administration.rst index 366dbbfd68..623dd72297 100644 --- a/doc/appendix/administration.rst +++ b/doc/appendix/administration.rst @@ -286,22 +286,25 @@ the repository. A Github workflow updates the official `github pages`_ site on every push to ``develop`` by generating the developer and user documentation with Doxygen and Sphinx. The "static" part of -the web site is modifiable by using the ``doc/gh-pages-base`` branch: it -contains an index file that should basically just point to the documentation. -Additionally there are two special repositories in the ``celeritas-project`` organization that are used for documentation and should also just be redirects. +the web site is modifiable by using the ``doc/gh-pages-base`` branch. This +branch contains an index file that points to the documentation; it also +includes auto-generated publications and references and the script to generate +them. +Additionally there are two special repositories in the ``celeritas-project`` +organization that are used for documentation and should also just be redirects. In summary, there are several possible sources of documentation, most of which should be simple redirects to reduce maintenance: - ``https://github.com/celeritas-project`` : a top-level organization README - generated by a special `.github ` repository + generated by a special `.github `_ repository - ``https://github.com/celeritas-project/celeritas`` : a code README generated by the ``README.md`` in the main Celeritas repo - ``https://celeritas-project.github.io``: a special organization-level - `github.io ` + `github.io `_ repository that should just redirect to the useful documentation - ``https://celeritas-project.github.io/celeritas``: generated from the - ``doc/gh-pages-base`` branch + ``doc/gh-pages-base`` branch and the Celeritas Zotero list - ``https://celeritas-project.github.io/celeritas/dev``: developer docs generated from Doxygen via the ``develop`` branch (see the ``doc/CMakeLists.txt`` file)