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

Fix for sphinx autodoc #99

Merged
merged 1 commit into from
Mar 17, 2024
Merged

Conversation

shashank-iitbhu
Copy link
Contributor

Contributor checklist


Description

  • Fix for sphinx autodoc not finding scribe_data module.
  • modified sys.path in conf.py

Related issue

Signed-off-by: Shashank Mittal <[email protected]>
Copy link

github-actions bot commented Mar 10, 2024

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. It'd be great to have you!

Maintainer checklist

  • The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution

    • The contributor's name and icon in remote commits should be the same as what appears in the PR
    • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Data repo
  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

@shashank-iitbhu
Copy link
Contributor Author

Getting all the documentation for checkquery and utils.
Screenshot 2024-03-10 at 3 59 28 PM

@shashank-iitbhu shashank-iitbhu deleted the autodoc-fix branch March 10, 2024 11:20
@shashank-iitbhu shashank-iitbhu restored the autodoc-fix branch March 10, 2024 11:46
@@ -18,7 +18,7 @@
#
import sphinx_rtd_theme

sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath("../../src"))
Copy link
Member

Choose a reason for hiding this comment

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

🙌 Nice!!

Quick question - trying to catch up on our progress with the docs.. just wondering about the extract_transform and load stuff. Do those get addressed with this change as well or is the plan for us to tackle them later?

Copy link
Contributor Author

@shashank-iitbhu shashank-iitbhu Mar 16, 2024

Choose a reason for hiding this comment

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

Can apply the same for extract_transform also, extract_wiki.py and process_wiki.py have some helper functions too.
not sure about load though.

Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

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

Thanks for this, @shashank-iitbhu! It was working for me as well before this, but then looking at it this does seem to be the right path from conf.py :) Will test some things out with this merged in!

@andrewtavis andrewtavis merged commit 1e07ac9 into scribe-org:main Mar 17, 2024
3 checks passed
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