Skip to content
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

WIP: Creation of Python autodoc using Sphinx #327

Closed
wants to merge 22 commits into from

Conversation

ParagEkbote
Copy link

@ParagEkbote ParagEkbote commented Oct 28, 2024

Summary

Implementation for Issue #64 . I have created an initial setup and sample pages are created under docs/build. Additionally, I have added a GitHub Action for creating these docs automatically.

To rebuild docs, write the following commands in the terminal:

  1. cd docs
  2. sphinx-build -b html docs/source docs/build

Help

I need guidance to cover the complete repository and its contents.

  1. How are the .rst(doc) files expected to be structured?
  2. Are there any additional references for making docs for every individual file, since the scope of the repository is quite large? Ideally, I would love to see each kernel explained and the monkey patch support files as well.

Note: I will create a different PR for creating docs using Material for Mkdocs.

@ParagEkbote ParagEkbote marked this pull request as ready for review November 1, 2024 08:01
@ParagEkbote ParagEkbote marked this pull request as draft November 2, 2024 14:20
@ParagEkbote ParagEkbote changed the title Creation of Python autodoc using Sphinx WIP: Creation of Python autodoc using Sphinx Nov 7, 2024
@ParagEkbote ParagEkbote closed this by deleting the head repository Dec 16, 2024
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.

1 participant