Skip to content

Conversation

Medyan-Naser
Copy link

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)
  • 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 .
  • Ruff passes

@mehdiataei
Copy link
Contributor

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 mehdiataei closed this Jul 23, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jul 23, 2025
@mehdiataei mehdiataei reopened this Jul 24, 2025
@Autodesk Autodesk unlocked this conversation Aug 7, 2025
Copy link

github-actions bot commented Aug 7, 2025

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

@Medyan-Naser
Copy link
Author

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

@Medyan-Naser Medyan-Naser marked this pull request as ready for review August 7, 2025 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants