XLB icon indicating copy to clipboard operation
XLB copied to clipboard

Set up documentation website using Sphinx and Read the Docs

Open Medyan-Naser opened this issue 5 months ago • 3 comments

Contributing Guidelines

Description

This PR adds a full documentation website for the XLB project using Sphinx and Read the Docs.

  • The original README.md has been split into multiple structured pages.
  • A new api_reference page has been added for future automated API documentation.
  • A docs/ folder was created to hold the Sphinx project files.
  • A .readthedocs.yml file was added to configure the Read the Docs build.
  • The site is live at: https://xlb.readthedocs.io/en/latest/

This setup provides a scalable and maintainable structure for XLB documentation going forward.

Type of change

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [X] Documentation update

How Has This Been Tested?

  • [ ] All pytest tests pass

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 .
  • [X] Ruff passes

Medyan-Naser avatar Jul 23 '25 22:07 Medyan-Naser

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.

mehdiataei avatar Jul 23 '25 23:07 mehdiataei

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

github-actions[bot] avatar Aug 07 '25 21:08 github-actions[bot]

I have read the CLA Document and I hereby sign the CLA

Medyan-Naser avatar Aug 07 '25 22:08 Medyan-Naser