Infinito.Nexus uses Sphinx to automatically generate its documentation and leverages the Awesome Sphinx Theme for a sleek and responsive design. Enjoy a seamless, visually engaging experience 🚀✨.
You can access the generated documentation here 🔗. Browse the latest updates and guides to get started.
This documentation project is developed by Kevin Veen-Birkenbach and is a part of the Infinito.Nexus ecosystem. It is created to provide clear, maintainable, and interactive documentation for the project. The tool is licensed under the MIT License and welcomes community contributions!
The container image is published on GitHub Container Registry (GHCR):
docker pull ghcr.io/kevinveenbirkenbach/infinito-sphinx:latestWhat the image does:
- Uses the
infinitobase image - Installs required build tools (e.g.
pandoc) - Runs
make setupinside the Infinito source tree - Builds the Sphinx HTML documentation
- Serves the generated docs via
http.server
docker run --rm -p 127.0.0.1:80:8000 \
ghcr.io/kevinveenbirkenbach/infinito-sphinx:latestThen open:
http://127.0.0.1/
services:
infinito_docs:
image: ghcr.io/kevinveenbirkenbach/infinito-sphinx:latest
container_name: infinito_docs
ports:
- "127.0.0.1:80:8000"Start the service:
docker compose up -dTo view all the available commands and options for starting and configuring the Infinito.Nexus Sphinx tool, simply run the following command:
infinito-sphinx --helpThis command provides an easy way to access all the options needed to work with Infinito.Nexus Sphinx and manage the project’s documentation. Whether you're setting up the environment or generating documentation, the --help command will guide you through all available functionalities. 🚀
Contributions are welcome! If you have any suggestions or encounter issues, feel free to open an issue or submit a pull request on GitHub.
