[go: up one dir, main page]
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.

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

Improve Read The Docs #469

Open
camilamaia opened this issue Aug 1, 2021 · 10 comments
Open

Improve Read The Docs #469

camilamaia opened this issue Aug 1, 2021 · 10 comments
Assignees
@jhermann
Labels
Automation Automates a process Documentation Improvements or additions to documentation

Comments

@camilamaia
Copy link
Member
camilamaia commented Aug 1, 2021 •
edited
Loading

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:
@camilamaia camilamaia added the Documentation Improvements or additions to documentation label Aug 1, 2021
@camilamaia camilamaia mentioned this issue Aug 1, 2021
Closed
@camilamaia camilamaia mentioned this issue Aug 1, 2021
Open
@jhermann
Copy link
Contributor
jhermann commented Aug 1, 2021 •
edited
Loading

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
Copy link
Contributor
jhermann commented Aug 1, 2021

@jhermann
Copy link
Contributor
jhermann commented Aug 1, 2021

@camilamaia this what you missed?

@Pradhvan
Copy link
Member
Pradhvan commented Aug 2, 2021

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

@jhermann jhermann added the Automation Automates a process label Aug 2, 2021
@camilamaia
Copy link
Member Author

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

@camilamaia
Copy link
Member Author

@camilamaia this what you missed?

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

image

image

Where are the docstings? ahhaha

@jhermann
Copy link
Contributor
jhermann commented Aug 3, 2021 •
edited
Loading

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

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

@Pradhvan
Copy link
Member

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

@jhermann
Copy link
Contributor

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

@Pradhvan
Copy link
Member
Pradhvan commented Sep 1, 2021

@jhermann cool! looking forward to it. 😄

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

@jhermann jhermann

Labels
Automation Automates a process Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jhermann @camilamaia @Pradhvan