Documentation branch

[AnishereMariam]

Description

• My pull request solved the issue Render Jupyter notebooks inside the Scribe-Data documentation #210. I was able to render the notebook in a toctree.
  Although, I have a bit of a challenge. I tried referring to the .ipynb file directly from the src folder, but it kept returning an error. I had to copy the file into the .rst folder for it to work. I am open to suggestions on how to fix that.

*I had other commits on this PR that fixed some minor bugs I encountered while running the docs file.
I fixed some indentations and code errors that affect the complete display of the Documentation file.

Testing

-->I tested my changes with the sphinx-build tool and am confident it works.

Issue fixed

#210 and some minor bugs.

[github-actions]

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. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

• The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[andrewtavis]

Hi @AnishereMariam 👋 Thanks for the efforts here! The notebook isn't showing up for me locally, but mybe it's how I'm building the docs. I always test with make html. Can you let me know what the command you're using is?

[AnishereMariam]

I test mine with sphinx-build -t html source build.
I am unable to use make html

[andrewtavis]

Thanks for the info, @AnishereMariam :) I realized that the problem for me was local likely, as I didn't have pandoc installed apparently. I changed one thing to make it so that the notebooks are never ran. This is really awesome 😊 Thanks so much for the great work here! Maybe we can work on some notebook based usage examples at some point :)

[AnishereMariam]

I would love to explore this phase more. It exposed me to some valuable learning experiences. I really enjoy working on this project, generally.

[andrewtavis]

Really enjoy having you on the project, @AnishereMariam :) You've had some great contributions :)

[andrewtavis]

If you have some further suggestions on how to improve the documentation, then please share!