Skip to content

Conversation

akhiltulluri
Copy link

@akhiltulluri akhiltulluri commented Jul 15, 2025

This is still WIP but provides a baseline setup for publishing docs with Sphinx, doxygen, breathe and readthedocs. Related to #127

Preview sample doc generated: https://libcachesimtest.readthedocs.io/en/latest/

@akhiltulluri akhiltulluri marked this pull request as draft July 15, 2025 05:18
@akhiltulluri
Copy link
Author

@1a1a11a - do I migrate everything under doc/ into using sphinx and reStructuredText?

Also with doxygen, what are the things that need to be in docs? I think with breathe we've to selectively choose what parts of the docs from code must be shown in sphinx and where.

@haochengxia
Copy link
Collaborator

haochengxia commented Jul 15, 2025

Thank you! Looks good overall.

Let's use env.yml, similar to https://github.com/microsoft/LightGBM/tree/master/docs, or directly use pyproject.toml to manage Python dependencies, which follow a relatively modern style.

@1a1a11a
Copy link
Owner

1a1a11a commented Jul 15, 2025

You can make the decision on what to include in the doc website. @haochengxia and I will help you iterate on this.

@1a1a11a
Copy link
Owner

1a1a11a commented Jul 15, 2025

@haochengxia do you think we should have a separate doc for the Python binding or mix with the main doc?

@haochengxia
Copy link
Collaborator

We could separate them to avoid overwhelming beginners who want to try out Python packages first.

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