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

Automatically Generating Docs From Sphinx #235

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Suryansh5545
Copy link
Member

@Suryansh5545 Suryansh5545 commented Dec 28, 2019

I have successfully created docs automatically from docstring using sphinx and i have used theme sphinx-rtd-theme and have edited it to look exactly like the previous docs html. The problem is the command and there description Which is in the middle is not exaclty same as previous one. and i dont know how can i control or edit it?

THE Result:-
Selection_061

Expected:-
Selection_060

@Suryansh5545 Suryansh5545 changed the title auto-docs Automatically Generating Docs From Sphinx Dec 28, 2019
@Suryansh5545
Copy link
Member Author

Also the person creating or editing will require the edited theme so that it look similar to old one.

@yashdusing
Copy link

@Suryansh5545 could you add the screenshot to the list of commands ?

@yashdusing
Copy link

Also, add the procedure to create the docs in the PR and the readme if possible

@yashdusing
Copy link

@Ram81 @pushkalkatara @RishabhJain2018 please review

@Suryansh5545
Copy link
Member Author

This is how the command list look in the newly auto generator docs. It doesn't look satisfactory to me .

Selection_062

@yashdusing
Copy link

@Suryansh5545 Could you please work on the spacing between the html elements ?

@Suryansh5545
Copy link
Member Author

Sir I have deleted old files which were not required now, have included the newly created evalai-theme , and created a README.md file. But i was unable to change the main style of how docs appear i can change the layout but can not influence them so i wasn't able to correct the spacing between html elements

@pushkalkatara
Copy link

@Suryansh5545 Please try to improve the theme. Maybe you can work on to get the previous one.
output

Maybe we can adopt a new theme, my fav one was the sphinx rtd theme - https://github.com/snide/sphinx_rtd_theme

What do you think @yashdusing?

@Suryansh5545
Copy link
Member Author

Suryansh5545 commented Dec 30, 2019

Should I work on using sphinx rtx theme?

@Suryansh5545
Copy link
Member Author

Sir I have implemented the sphinx_rtd_theme and i also removed some modules from the evalai.rtd file as they have no doc string and were covering space

@Suryansh5545
Copy link
Member Author

Selection_007

Copy link
Member

@krtkvrm krtkvrm left a comment

Choose a reason for hiding this comment

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

LGTM 💯

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.

None yet

4 participants