evalai-cli icon indicating copy to clipboard operation
evalai-cli copied to clipboard

Automatically Generating Docs From Sphinx

Open Suryansh5545 opened this issue 5 years ago • 11 comments

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 avatar Dec 28 '19 18:12 Suryansh5545

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

Suryansh5545 avatar Dec 28 '19 18:12 Suryansh5545

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

yashdusing avatar Dec 28 '19 18:12 yashdusing

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

yashdusing avatar Dec 28 '19 18:12 yashdusing

@Ram81 @pushkalkatara @RishabhJain2018 please review

yashdusing avatar Dec 28 '19 18:12 yashdusing

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

Selection_062

Suryansh5545 avatar Dec 28 '19 18:12 Suryansh5545

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

yashdusing avatar Dec 28 '19 18:12 yashdusing

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

Suryansh5545 avatar Dec 29 '19 19:12 Suryansh5545

@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?

pushkalkatara avatar Dec 30 '19 14:12 pushkalkatara

Should I work on using sphinx rtx theme?

Suryansh5545 avatar Dec 30 '19 15:12 Suryansh5545

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 avatar Dec 31 '19 07:12 Suryansh5545

Selection_007

Suryansh5545 avatar Dec 31 '19 07:12 Suryansh5545