-
Notifications
You must be signed in to change notification settings - Fork 55
Set up documentation website using Sphinx and Read the Docs #141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Hi Meydan, thanks a lot for your PR. We really appreciate the effort. We’re currently using MK Docs for our documentation and don’t have plans to migrate away from it. If you’re interested in contributing further, it would be great to have your help improving the existing documentation. |
All contributors have signed the CLA ✍️ ✅ |
I have read the CLA Document and I hereby sign the CLA |
Contributing Guidelines
Description
This PR adds a full documentation website for the XLB project using Sphinx and Read the Docs.
README.md
has been split into multiple structured pages.api_reference
page has been added for future automated API documentation.docs/
folder was created to hold the Sphinx project files..readthedocs.yml
file was added to configure the Read the Docs build.This setup provides a scalable and maintainable structure for XLB documentation going forward.
Type of change
How Has This Been Tested?
Linting and Code Formatting
Make sure the code follows the project's linting and formatting standards. This project uses Ruff for linting.
To run Ruff, execute the following command from the root of the repository:
ruff check .