Skip to content

Documentation #124

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Documentation #124

wants to merge 9 commits into from

Conversation

ManvithaPonnapati
Copy link
Collaborator

No description provided.

sidnarayanan
sidnarayanan approved these changes Oct 24, 2024
View reviewed changes
Copy link
Collaborator

@sidnarayanan sidnarayanan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! We should probably add a CI job or something to auto-update docs

jamesbraza
jamesbraza reviewed Oct 24, 2024
View reviewed changes
jamesbraza
jamesbraza reviewed Oct 24, 2024
View reviewed changes
Copy link
Collaborator

@jamesbraza jamesbraza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add sphinx to the dev-dependencies

jamesbraza
jamesbraza reviewed Oct 24, 2024
View reviewed changes
Copy link
Collaborator

@jamesbraza jamesbraza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the autodoc generated RST files are not yet useful to people, we need to put the HTML rendering of the autodoc somewhere. There are GitHub Actions for this

@ManvithaPonnapati
Copy link
Collaborator Author

@jamesbraza We can setup GitHub Pages ? I don't have permissions to do this on this repo . https://Future-House.github.io/ldp/ ?

@jamesbraza
Copy link
Collaborator

@ManvithaPonnapati I gave you permissions now to set it up, lmk if you don't have the permissions for it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jamesbraza jamesbraza jamesbraza left review comments

@sidnarayanan sidnarayanan sidnarayanan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ManvithaPonnapati @jamesbraza @sidnarayanan