Improve Read The Docs

[camilamaia]

Feature request

Description the feature

We are now publishing our sphinx doc at Read The Docs: https://scanapi.readthedocs.io. But, it still needs some improvements. Some docstrings are not showing up, like hide_utils for example. Also, the structure is not clean an easy to navigate.

Do you have any suggestions on how to add this feature in scanapi ?

@jhermann proposed to use a structure he created before:

→ https://github.com/Springerle/py-generic-project/tree/master/%7B%7Bcookiecutter.repo_name%7D%7D/docs
→ See https://confluencer.readthedocs.io/ for an example rendering.

It is super clean and neat 👍

Also:

• Change theme to Furo
• Move Wiki to Read The Docs #474

[jhermann]

We can still switch to the theme I think @camilamaia mentioned somewhere (can you repeat that here please?).

https://sphinx-book-theme.readthedocs.io/ is worth consideration too.

Also, some of the wiki pages (e.g. contributor getting started) should be moved into the docs as outlined in #474.

[jhermann]

[jhermann]

@camilamaia this what you missed?

[Pradhvan]

We can still switch to the theme I think @camilamaia mentioned somewhere (can you repeat that here please?).

It was Furo theme

Also, some of the wiki pages (e.g. contributor getting started) should be moved into the docs as outlined in #474.

I agree

[camilamaia]

@jhermann I've updated the issue description with your suggestions! Thanks. Let me know if something else is missing, please

[camilamaia]

@camilamaia this what you missed?

Yessss! Where did you find it? 😂 I can't find anything in the current docs haha

Where are the docstings? ahhaha

[jhermann]

This is in a branch and not ready for primetime yet.

Specifically jhermann/rituals#52 needs to be done first.

[Pradhvan]

@jhermann just checking in. Are you still working on this ?

[jhermann]

Sorry, was busy with other things. Yes, it works (for me), must release some stuff for a merge.

[Pradhvan]

@jhermann cool! looking forward to it. 😄