diff --git a/.github/workflows/mkdocs-build.yml b/.github/workflows/mkdocs-build.yml index cf00fc65af..ee82727727 100644 --- a/.github/workflows/mkdocs-build.yml +++ b/.github/workflows/mkdocs-build.yml @@ -17,7 +17,7 @@ jobs: - uses: actions/setup-python@v5 with: python-version: 3.x - - name: Setup Python environment - run: pip install -r requirements.txt + - name: Install uv + uses: astral-sh/setup-uv@v5 - name: Build docs with --strict run: make build-docs diff --git a/.github/workflows/update-livesite.yml b/.github/workflows/update-livesite.yml index 321f9d0dd3..2ba8427c33 100644 --- a/.github/workflows/update-livesite.yml +++ b/.github/workflows/update-livesite.yml @@ -15,5 +15,6 @@ jobs: - uses: actions/setup-python@v5 with: python-version: 3.x - - run: pip install -r requirements.txt - - run: mkdocs gh-deploy --force --strict + - name: Install uv + uses: astral-sh/setup-uv@v5 + - run: uv run zensical gh-deploy --force --strict diff --git a/.gitignore b/.gitignore index bb75aa84ce..41a6c77e07 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,4 @@ env/ venv/ .idea/ .DS_Store -.python-version inbound-links.md -pyproject.toml -uv.lock diff --git a/Makefile b/Makefile index f2f0f8f874..15dfdd6b7a 100644 --- a/Makefile +++ b/Makefile @@ -2,27 +2,19 @@ .PHONY: install-dev install-dev: - python -m pip install --upgrade wheel pip - pip install -r requirements.txt + uv sync .PHONY: generate-inbound-links generate-inbound-links: - python3 scripts/generate_inbound_links.py + uv run python scripts/generate_inbound_links.py -# URL validation approach #1 -# .PHONY: build-docs -# build-docs: generate-inbound-links -# mkdocs build --strict -# rm -rfd site/inbound-links - -# URL validation approach #2 .PHONY: build-docs build-docs: @echo "Building site..." - mkdocs build --strict + uv run zensical build --strict @echo "Validating inbound links..." - python3 scripts/validate_inbound_links.py + uv run python scripts/validate_inbound_links.py .PHONY: clean clean: @@ -34,10 +26,9 @@ clean: .PHONY: all all: build-docs -# URL validation approach #1 .PHONY: serve serve: generate-inbound-links @echo "Finding available port..." - $(eval PORT := $(shell python scripts/find_port.py)) - @echo "Starting MkDocs server on port $(PORT)..." - mkdocs serve -a 127.0.0.1:$(PORT) + $(eval PORT := $(shell uv run python scripts/find_port.py)) + @echo "Starting Zensical server on port $(PORT)..." + uv run zensical serve -a 127.0.0.1:$(PORT) diff --git a/README.md b/README.md index 8373c40424..f182a974d4 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,9 @@ Source for the documentation located at https://docs.alcf.anl.gov/ ## Contributing to documentation -### Python environment +### Prerequisites -To build documentation locally, you need a Python environment with `mkdocs` installed. Check that Python 3.6+ is installed: -```bash -python --version -``` -e.g. `Python 3.8.3`. Then create a new virtual env to isolate the `mkdocs` installation: -```bash -python -m venv env -source env/bin/activate -``` +To build documentation locally, you need [uv](https://docs.astral.sh/uv/getting-started/installation/) installed. It manages Python, virtual environments, and dependencies automatically. ### Git @@ -24,9 +16,9 @@ cd user-guides git submodule init; git submodule update ``` -### Installing MkDocs +### Installing dependencies -To install `mkdocs` in the current environment: +`uv sync` reads `pyproject.toml` and installs Zensical and all plugins into a managed virtualenv: ```bash cd user-guides make install-dev @@ -34,12 +26,12 @@ make install-dev ### Preview the docs locally and test for errors -Run `mkdocs serve` or `make serve` to auto-build and serve the docs for preview in your web browser: +Run `zensical serve` or `make serve` to auto-build and serve the docs for preview in your web browser: ```bash make serve ``` -GitHub Actions are used to automatically validate all changes in pull requests before they are merged, by executing `mkdocs build --strict`. The [`--strict`](https://www.mkdocs.org/user-guide/configuration/#validation) flag will print out warnings and return a nonzero code if any of a number of checks fail (e.g. broken relative links, orphaned Markdown pages that are missing from the navigation sidebar, etc.). To see if your changes will pass these tests, run the following command locally: +GitHub Actions are used to automatically validate all changes in pull requests before they are merged, by executing `zensical build --strict`. The `--strict` flag will print out warnings and return a nonzero code if any of a number of checks fail (e.g. broken relative links, orphaned Markdown pages that are missing from the navigation sidebar, etc.). To see if your changes will pass these tests, run the following command locally: ``` make build-docs ``` @@ -76,5 +68,5 @@ git push origin YOURBRANCH # push the changes from local branch up to yo External URLs pointing to our docs are tracked in [includes/validate-inbound-URLs.txt](includes/validate-inbound-URLs.txt) and validated during build to prevent broken links from the main ALCF site, etc. Add URLs to that file to ensure that the matching `.md` in this repository is never moved, renamed, or deleted. There are two Python `scripts/` that perform this function: -1. (works with `mkdocs build` and `serve`): Translate URLs to relative path links to their matching source `.md` files; write these links to `docs/inbound-links.md`. Use MkDocs' built-in validation (adding `--strict` flag when running `mkdocs build`, in order to return an error code if they are invalid). -2. (works with `mkdocs build`, only): Use a lightweight post-build validation on generated `site/` directory HTML contents. +1. (works with `zensical build` and `serve`): Translate URLs to relative path links to their matching source `.md` files; write these links to `docs/inbound-links.md`. Use Zensical's built-in validation (adding `--strict` flag when running `zensical build`, in order to return an error code if they are invalid). +2. (works with `zensical build`, only): Use a lightweight post-build validation on generated `site/` directory HTML contents. diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index e86ca871ba..0000000000 --- a/mkdocs.yml +++ /dev/null @@ -1,520 +0,0 @@ -site_name: ALCF User Guides -repo_name: 'argonne-lcf/user-guides' -repo_url: 'https://github.com/argonne-lcf/user-guides' -site_url: 'https://docs.alcf.anl.gov/' -edit_uri: 'edit/main/docs/' - -theme: - name: 'material' - custom_dir: overrides - language: 'en' - palette: - # Palette toggle for automatic mode - - media: "(prefers-color-scheme)" - toggle: - icon: material/brightness-auto - name: Switch to light mode - - # Palette toggle for light mode - - media: "(prefers-color-scheme: light)" - scheme: alcf - primary: custom - accent: custom - toggle: - # icon: material/brightness-7 - icon: material/weather-sunny - name: Switch to dark mode - - # Palette toggle for dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: custom - accent: custom - toggle: - icon: material/weather-night - name: Switch to system preference - - font: - text: proxima-nova # removed in #545. remove again? - - features: - - content.action.edit - - content.action.view - - content.code.copy - - content.code.annotate - - content.tooltips - #- content.code.select # insiders-4.32.0 - #- navigation.expand - - navigation.indexes - - navigation.instant - - navigation.instant.progress - #- navigation.instant.prefetch # insiders-4.36 - #- material.extensions.preview ... # insiders-4.52 - - navigation.path - #- navigation.prune # for sites with 100s or 1k pages; only render visible navbar items (i.e. clicking on collapsed sections will navigate to the first page in that section, since it isnt rendered) - #- navigation.tabs # for non-mobile browsers, move top-level sections from left nav sidebar to top under header - - navigation.top - - navigation.tracking - - navigation.sections - - toc.follow - #- toc.integrate # move right-side intra-page TOC within left nav sidebar - - search.highlight - - search.suggest - - logo: images/logo.svg - favicon: "images/favicon.svg" - -extra_css: - - stylesheets/alcf-extra.css - -extra_javascript: - - javascripts/alcf-extra.js - - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js - - https://unpkg.com/tablesort@5.3.0/dist/tablesort.date.js - - https://unpkg.com/tablesort@5.3.0/dist/tablesort.number.js - - https://unpkg.com/tablesort@5.3.0/dist/tablesort.filesize.js - - https://unpkg.com/tablesort@5.3.0/dist/tablesort.dotsep.js - - javascripts/tablesort.js - -markdown_extensions: - - footnotes - - admonition - - codehilite - - tables - - attr_list - - md_in_html - - abbr - - pymdownx.critic - - pymdownx.inlinehilite - - pymdownx.keys - - pymdownx.caret - - pymdownx.mark - - pymdownx.tilde - - pymdownx.snippets: - base_path: ["."] # for root of repo, default since that is where mkdocs.yml is - # base_path: ["docs"] - dedent_subsections: True # experimental; new in 9.10 (2023-03-05) - check_paths: True - url_download: True - auto_append: - - includes/abbreviations.md - - pymdownx.superfences - - pymdownx.details - - pymdownx.inlinehilite - - pymdownx.highlight: - use_pygments: true - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.tabbed: - alternate_style: true - combine_header_slug: true - - pymdownx.tasklist: - custom_checkbox: true - - pymdownx.blocks.definition - - pymdownx.blocks.caption - - - toc: - permalink: true -validation: - omitted_files: warn - absolute_links: warn - unrecognized_links: warn - anchors: warn - not_found: warn - -extra: - homepage: 'https://docs.alcf.anl.gov' - social: # placed in overridden footer - - icon: 'fontawesome/brands/github-alt' - link: 'https://github.com/argonne-lcf/user-guides' - - icon: 'fontawesome/brands/youtube' - link: 'https://www.youtube.com/c/argonneleadershipcomputingfacility' - - icon: 'fontawesome/brands/x-twitter' - link: 'https://x.com/argonne_lcf' - - icon: 'fontawesome/brands/facebook' - link: 'https://www.facebook.com/argonne.lcf/' - analytics: - provider: google - property: G-4M48E2L33R - -plugins: - - search: - lang: en - separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' - - minify: - minify_html: true - - redirects: - redirect_maps: - 'support/technical-support.md': 'support/ticket.md' - # 'data-management/filesystem-and-storage/file-systems.md': 'data-management/filesystem-and-storage/index.md' - -nav: - # - ALCF User Guides: - # - index.md - - Getting Started: https://www.alcf.anl.gov/support-center/get-started - - Contribute to User Guides: support/docs-issues.md - - - User Support: - - support/index.md - - Submit a Ticket: support/ticket.md - - Get Help & Connect: - - support/get-help/index.md - - Mailing Lists: support/get-help/mailing-lists.md - - Request Software: support/get-help/software-requests.md - - ALCF Users Slack: support/get-help/alcf-users-slack.md - - Aurora Office Hours: support/get-help/office-hours.md - - AskALCF Chatbot: support/get-help/askalcf.md - - Machines: - - machines/index.md - - Aurora: - - aurora/index.md - - Node Performance Overview: aurora/node-performance-overview/node-performance-overview.md - - Getting Started: aurora/getting-started-on-aurora.md - - Known Issues: aurora/known-issues.md - - System Updates: aurora/system-updates.md - - Aurora Programming Environment: aurora/aurora-pe.md - # TODO: "&" vs. "and" in sidebar page titles? - - Compiling and Linking: - - aurora/compiling-and-linking/index.md - - Programming Models: aurora/compiling-and-linking/aurora-programming-models.md - - Example Program and Makefile: aurora/compiling-and-linking/aurora-example-program-makefile.md - # - LLVM Compilers: aurora/compiling-and-linking/llvm-compilers-aurora.md - # - GNU Compilers: aurora/compiling-and-linking/gnu-compilers-aurora.md - # - CCE Compilers: aurora/compiling-and-linking/cce-compilers-aurora.md - - Build Tools: - - CMake: aurora/build-tools/cmake-aurora.md - - Running Jobs: aurora/running-jobs-aurora.md - - Data Management: - - Copper: aurora/data-management/copper/copper.md - - DAOS: aurora/data-management/daos/daos-overview.md - - Lustre (Flare): aurora/data-management/lustre/flare.md - - Moving data to Aurora: - - Data Mover: aurora/data-management/moving_data_to_aurora/datamover.md - - Globus: aurora/data-management/moving_data_to_aurora/globus.md - - Applications and Libraries: - - Applications: - - LAMMPS: aurora/applications-and-libraries/applications/lammps.md - - Libraries: - - Cabana: aurora/applications-and-libraries/libraries/cabana-aurora.md - #- Math Libraries: aurora/applications-and-libraries/libraries/math-libraries.md - #- MKL: aurora/applications-and-libraries/libraries/mkl.md - #- MPI: aurora/applications-and-libraries/libraries/mpi.md - - oneDAL: aurora/applications-and-libraries/libraries/onedal.md - - Spack PE: aurora/applications-and-libraries/libraries/spack-pe.md - - Containers: aurora/containers/containers.md - - Data Science: - - Python: aurora/data-science/python.md - - Jupyter: aurora/data-science/jupyter.md - - Profiling: aurora/data-science/profiling_dl.md - - Frameworks: - - DeepSpeed: aurora/data-science/frameworks/deepspeed.md - - Megatron-DeepSpeed: aurora/data-science/frameworks/megatron-deepspeed.md - - PyTorch: aurora/data-science/frameworks/pytorch.md - - TensorFlow: aurora/data-science/frameworks/tensorflow.md - - Dask: aurora/data-science/frameworks/dask.md - - oneCCL: aurora/data-science/frameworks/oneCCL.md - - scikit-learn: aurora/data-science/frameworks/scikit-learn.md - - oneDAL: aurora/applications-and-libraries/libraries/onedal.md - - GPyTorch: aurora/data-science/frameworks/gpytorch.md - - PyTorch Geometric (PyG): aurora/data-science/frameworks/pyg.md - - AI Inference: - - LibTorch: aurora/data-science/inference/libtorch.md - - OpenVINO: aurora/data-science/inference/openvino.md - - vLLM: aurora/data-science/inference/vllm.md - - Applications: - - Milvus: aurora/data-science/applications/milvus.md - - Programming Models: - - Kokkos: aurora/programming-models/kokkos-aurora.md - - Level Zero: aurora/programming-models/level-0.md - - OpenCL: aurora/programming-models/opencl-aurora.md - - OpenMP: aurora/programming-models/openmp-aurora.md - - SYCL: aurora/programming-models/sycl-aurora.md - - HIP: aurora/programming-models/hip-aurora.md - - Julia: aurora/programming-models/julia.md - - Debugging Tools: - - aurora/debugging/index.md - - gdb-oneapi: aurora/debugging/gdb-oneapi.md - - DDT: aurora/debugging/ddt-aurora.md - - gdb4hpc: aurora/debugging/gdb4hpc.md - - Codee: aurora/debugging/codee.md - - Intel_Sanitizer: aurora/debugging/Intel_sanitizer.md - - Performance Tools: - - aurora/performance-tools/index.md - - iprof: aurora/performance-tools/iprof.md - - unitrace: aurora/performance-tools/unitrace.md - - xpu-smi: aurora/performance-tools/xpu-smi.md - - APS: aurora/performance-tools/aps.md - - Advisor: aurora/performance-tools/advisor.md - - VTune: aurora/performance-tools/vtune.md - - Services: - - GitLab CI: aurora/services/gitlab-ci.md - - Visualization: - - aurora/visualization/index.md - - ParaView (Launch from Client): aurora/visualization/paraview.md - - ParaView (Manual Launch): aurora/visualization/paraview-manual-launch.md - - VisIt: aurora/visualization/visit.md - - - Workflows: - - ADIOS2: aurora/workflows/adios.md - - Balsam: aurora/workflows/balsam.md - - libEnsemble: aurora/workflows/libensemble.md - - Parsl: aurora/workflows/parsl.md - - SmartSim: aurora/workflows/smartsim.md - - - AI Testbed: - - ai-testbed/index.md - - Cerebras: - - ai-testbed/cerebras/index.md - - Getting Started: ai-testbed/cerebras/getting-started.md - - Running a Model/Program: ai-testbed/cerebras/running-a-model-or-program.md - - Customizing Environments: ai-testbed/cerebras/customizing-environment.md - - Job Queuing and Submission: ai-testbed/cerebras/job-queuing-and-submission.md - - Example Programs: ai-testbed/cerebras/example-programs.md - #- Performance Tools: ai-testbed/cerebras/performance-tools.md - - Tunneling and Forwarding Ports: ai-testbed/cerebras/tunneling-and-forwarding-ports.md - - Miscellaneous: ai-testbed/cerebras/miscellaneous.md - - CSL: ai-testbed/cerebras/csl.md - - Grafana: ai-testbed/cerebras/accessing_cerebras_grafana_dashboard.md - - Graphcore: - - ai-testbed/graphcore/index.md - - Getting Started: ai-testbed/graphcore/getting-started.md - - Virtual Environment: ai-testbed/graphcore/virtual-environments.md - - Running a Model/Program: ai-testbed/graphcore/running-a-model-or-program.md - - Job Queuing and Submission: ai-testbed/graphcore/job-queuing-and-submission.md - - Example Programs: ai-testbed/graphcore/example-programs.md - - Miscellaneous: ai-testbed/graphcore/miscellaneous.md - - Documentation: ai-testbed/graphcore/documentation.md - - Groq: - - ai-testbed/groq/index.md - - Getting Started: ai-testbed/groq/getting-started.md - - Running a Model/Program: ai-testbed/groq/running-a-model-or-program.md - #- Example Programs: ai-testbed/groq/example-programs.md - - Virtual Environments: ai-testbed/groq/virtual-environments.md - - Job Queueing and Submission: ai-testbed/groq/job-queuing-and-submission.md - - Profiling with GroqView: ai-testbed/groq/groqview.md - - Examples: ai-testbed/groq/examples.md - - SambaNova: - - SN30: - - ai-testbed/sambanova/index.md - - Getting Started: ai-testbed/sambanova/getting-started.md - - Virtual Environment: ai-testbed/sambanova/virtual-environment.md - - Running a Model/Program: ai-testbed/sambanova/running-a-model-or-program.md - - Job Queuing and Submission: ai-testbed/sambanova/job-queuing-and-submission.md - - Example Programs: ai-testbed/sambanova/example-programs.md - - Example Multi-Node Programs: ai-testbed/sambanova/example-multi-node-programs.md - # - Running BERT Large on Sambanova DataScale SN30-8: ai-testbed/sambanova/running-bert-large-on-sn30.md - - ModelZoo Samples: ai-testbed/sambanova/example-modelzoo-programs.md - - Tunneling and Forwarding Ports: ai-testbed/sambanova/tunneling-and-forwarding-ports.md - - SambaTune for profiling and performance tuning: ai-testbed/sambanova/sambatune.md - - Miscellaneous: ai-testbed/sambanova/miscellaneous.md - - SambaNova Documentation: ai-testbed/sambanova/documentation.md - - Metis Inference: - - ai-testbed/sn40l_inference/index.md - - Using an Inference Endpoint: ai-testbed/sn40l_inference/using_an_inference_endpoint.md - - Data Management: ai-testbed/data-management/data-management-overview.md - - - Crux: - - crux/index.md - - Getting Started: crux/getting-started.md - - Running Jobs: crux/queueing-and-running-jobs/running-jobs.md - - Compiling and Linking: crux/compiling-and-linking/compiling-and-linking-overview.md - - Containers: crux/containers/containers.md - - Data Science: - - Python: crux/data-science/python.md - #- Visualization: - #- crux/visualization/index.md - #- ParaView (Launch from Client): crux/visualization/paraview.md - - - Polaris: - - polaris/index.md - - Getting Started: polaris/getting-started.md - - Known Issues: polaris/known-issues.md - - System Updates: polaris/system-updates.md - - Compiling and Linking: - - polaris/compiling-and-linking/index.md - - Programming Models: polaris/compiling-and-linking/polaris-programming-models.md - - Example Program and Makefile: polaris/compiling-and-linking/polaris-example-program-makefile.md - - CCE Compilers: polaris/compiling-and-linking/cce-compilers-polaris.md - - GNU Compilers: polaris/compiling-and-linking/gnu-compilers-polaris.md - - NVIDIA Compilers: polaris/compiling-and-linking/nvidia-compiler-polaris.md - - LLVM Compilers: polaris/compiling-and-linking/llvm-compilers-polaris.md - - oneAPI Toolkit: polaris/compiling-and-linking/oneapi-compiler.md - - Build Tools: - - CMake: polaris/build-tools/cmake-polaris.md - - Running Jobs: - - polaris/running-jobs/index.md - - Using GPUs: polaris/running-jobs/using-gpus.md - - Applications and Libraries: - - Applications: - - Amber: polaris/applications-and-libraries/applications/amber.md - - GROMACS: polaris/applications-and-libraries/applications/gromacs.md - - LAMMPS: polaris/applications-and-libraries/applications/lammps.md - - NAMD: polaris/applications-and-libraries/applications/namd.md - - NekRS: polaris/applications-and-libraries/applications/nekrs.md - - OpenMM: polaris/applications-and-libraries/applications/openmm.md - - QMCPACK: polaris/applications-and-libraries/applications/QMCPACK.md - - Quantum ESPRESSO: polaris/applications-and-libraries/applications/QuantumESPRESSO.md - - VASP: polaris/applications-and-libraries/applications/vasp.md - - Libraries: - - Math Libraries: polaris/applications-and-libraries/libraries/math-libraries.md - - Cabana: polaris/applications-and-libraries/libraries/cabana-polaris.md - - Spack PE: polaris/applications-and-libraries/libraries/spack-pe.md - - NCCL: polaris/applications-and-libraries/libraries/nccl.md - - XALT: polaris/applications-and-libraries/libraries/xalt.md - - Containers: polaris/containers/containers.md - - Data Science: - - Python: polaris/data-science/python.md - - Profiling: polaris/data-science/profiling_dl.md - - Frameworks: - - TensorFlow: polaris/data-science/frameworks/tensorflow.md - - PyTorch: polaris/data-science/frameworks/pytorch.md - - JAX: polaris/data-science/frameworks/jax.md - - DeepSpeed: polaris/data-science/frameworks/deepspeed.md - - LibTorch: polaris/data-science/frameworks/libtorch.md - - GPyTorch: polaris/data-science/frameworks/gpytorch.md - - Applications: - - Megatron-DeepSpeed: polaris/data-science/applications/megatron-deepspeed.md - - gpt-neox: polaris/data-science/applications/gpt-neox.md - - Milvus: polaris/data-science/applications/milvus.md - - Programming Models: - - OpenMP: polaris/programming-models/openmp-polaris.md - - SYCL: polaris/programming-models/sycl-polaris.md - - Kokkos: polaris/programming-models/kokkos-polaris.md - - Julia: polaris/programming-models/julia.md - - Debugging Tools: - - CUDA-GDB: polaris/debugging-tools/CUDA-GDB.md - - Performance Tools: - - NVIDIA-Nsight: polaris/performance-tools/NVIDIA-Nsight.md - - Visualization: - - polaris/visualization/index.md - - ParaView (Launch from Client): polaris/visualization/paraview.md - - ParaView (Manual Launch): polaris/visualization/paraview-manual-launch.md - - VisIt: polaris/visualization/visit.md - - FFmpeg: polaris/visualization/ffmpeg.md - - ImageMagick: polaris/visualization/imagemagick.md - - ParaView Tutorial: polaris/visualization/paraview-tutorial.md - - VNC: polaris/visualization/vnc.md - - Workflows: - - Balsam: polaris/workflows/balsam.md - - Dragon: polaris/workflows/dragon.md - - Parsl: polaris/workflows/parsl.md - - libEnsemble: polaris/workflows/libensemble.md - - SmartSim: polaris/workflows/smartsim.md - - - Sophia: - - sophia/index.md - - Getting Started: sophia/getting-started.md - - Running Jobs: sophia/queueing-and-running-jobs/running-jobs.md - - Compiling and Linking: sophia/compiling-and-linking/compiling-and-linking-overview.md - - Containers: sophia/containers/containers.md - - Data Science: - - Python: sophia/data-science/python.md - - Fine-tuning with Autotrain: sophia/data-science/fine-tune-LLM-with-Autotrain.md - - Dask: sophia/data-science/dask.md - - Visualization: - - sophia/visualization/index.md - - ParaView (Launch from Client): sophia/visualization/paraview.md - - - Running Jobs with PBS: - - running-jobs/index.md - - Example Job Scripts: running-jobs/example-job-scripts.md - - Common PBS Issues: running-jobs/known-issues.md - - Machine Reservations: running-jobs/machine-reservations.md - - - Data Management: - - data-management/index.md - - File System & Storage: # TODO: next index.md might be better as above level-1 section index.md - - data-management/filesystem-and-storage/index.md - - HPSS: data-management/filesystem-and-storage/hpss.md - - Disk Quota: data-management/filesystem-and-storage/disk-quota.md - - Transfer & Sharing: - - SFTP and SCP: data-management/data-transfer/sftp-scp.md - - Using Globus: data-management/data-transfer/using-globus.md - - ALCF Community Data Co-Op: data-management/acdc/acdc.md - - Sharing on Eagle Using Globus: data-management/acdc/eagle-data-sharing.md - - - Services: - - services/index.md - - Inference Endpoints: services/inference-endpoints.md - - JupyterHub: services/jupyter-hub.md - - Continuous Integration: - - General: services/continuous-integration.md - - GitLab CI: services/gitlab-ci.md - - - Account & Project Management: - - account-project-management/index.md - - MyALCF: account-project-management/MyALCF.md - - Accounts and Access: - - account-project-management/accounts-and-access/index.md - - Obtaining a Token: account-project-management/accounts-and-access/obtaining-a-token.md - - Logging in with a Token: account-project-management/accounts-and-access/logging-in-with-tokens.md - - Troubleshooting Tokens: account-project-management/accounts-and-access/troubleshooting-tokens.md - - Accounts and Access FAQs: account-project-management/accounts-and-access/accounts-and-access-faqs.md - - Project Management: - - Starting Your ALCF Award: account-project-management/project-management/starting-alcf-award.md - - Managing Your Team Members: account-project-management/project-management/team-management.md - - Reporting: account-project-management/project-management/project-reports.md - - Allocations: - - account-project-management/allocation-management/index.md - - Managing Your Allocations: account-project-management/allocation-management/allocation-management.md - - sbank Allocation Accounting System: account-project-management/allocation-management/sbank-allocation-accounting-system.md - - - Facility Policies: - - policies/index.md - - ALCF Acknowledgement Policy: policies/alcf-acknowledgement-policy.md - - Account Policies: - - policies/accounts/index.md - - Account Sponsorship & Retention Policy: policies/accounts/account-sponsorship-retention-policy.md - - User Authentication Policy: policies/accounts/user-authentication-policy.md - - Scheduling Policies: - - policies/queue-scheduling/index.md - - Refund Policy: policies/queue-scheduling/refund-policy.md - - Pullback Policy: policies/queue-scheduling/pullback-policy.md - - Data and Software Policies: - - Data Policy: policies/data-and-software-policies/data-policy.md - - Software Policy: policies/data-and-software-policies/software-policy.md - - - Acronyms: acronyms.md - -# Pages that are not in navigation but still built -# These always end up in the generated site (both mkdocs "build" and "serve") -not_in_nav: | - not_in_nav/ - index.md - inbound-links.md - aurora/bugs-table.md - #account-project-management/allocation-management/not_in_nav/ - -# Pages that will never end up in a generated site (neither mkdocs "build" or "serve") (implies not_in_nav) -exclude_docs: | - unused/ - old/ - todo.md - TODO.md - notes.md - sophia/not_in_nav/ - -# (old ThetaGPU docs, probably better to rename folder+exclude from livesite; or port old -# content to Sophia and remove the rest entirely) - -# Pages still built during "mkdocs serve" for local testing, but not during "mkdocs build" -# appears to suppress not_in_nav WARNINGs for these pages, too -# emits harmless INFO logs that will disappear during "mkdocs build" -draft_docs: | - drafts/ - # TODO: complete or remove Aurora placeholder pages - aurora/compiling-and-linking/llvm-compilers-aurora.md - aurora/compiling-and-linking/gnu-compilers-aurora.md - aurora/compiling-and-linking/cce-compilers-aurora.md - aurora/applications-and-libraries/libraries/math-libraries.md - aurora/applications-and-libraries/libraries/mkl.md - aurora/applications-and-libraries/libraries/mpi.md - # KGF: nothing in aurora/applications-and-libraries/applications/ ! - aurora/performance-tools/performance-overview.md -# note, trailing inline comments under draft_docs, etc blocks break mkdocs parsing, -# despite official example https://www.mkdocs.org/user-guide/configuration/#draft_docs - -watch: - - includes/ - - overrides/ diff --git a/overrides/partials/footer.html b/overrides/partials/footer.html index 2fcd5b2838..1419898707 100644 --- a/overrides/partials/footer.html +++ b/overrides/partials/footer.html @@ -24,12 +24,7 @@

{% if config.extra.social %}
{% for social in config.extra.social %} - {% set title = social.name %} - {% if not title and "//" in social.link %} - {% set _,url = social.link.split("//") %} - {% set title = url.split("/")[0] %} - {% endif %} - + {% include ".icons/" ~ social.icon ~ ".svg" %} {% endfor %} diff --git a/overrides/partials/nav.html b/overrides/partials/nav.html index ea512c0536..f5d80dcc41 100644 --- a/overrides/partials/nav.html +++ b/overrides/partials/nav.html @@ -26,7 +26,7 @@
{% endif %}