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

Creation of Python autodoc using Sphinx #327

Draft
wants to merge 19 commits into
base: main
Choose a base branch
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.

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 files.

  1. How can the files be structured for creating html pages?
  2. Are there any additional references for writing docs for every individual file, since the scope of the repository is quite large?

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