Cloud-CV / evalai-cli

:cloud: :rocket: Official EvalAI Command Line Tool
https://cli.eval.ai
BSD 3-Clause "New" or "Revised" License
55 stars 63 forks source link

Automatically Generating Docs From Sphinx #235

Open Suryansh5545 opened 4 years ago

Suryansh5545 commented 4 years ago

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 commented 4 years ago

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

yashdusing commented 4 years ago

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

yashdusing commented 4 years ago

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

yashdusing commented 4 years ago

@Ram81 @pushkalkatara @RishabhJain2018 please review

Suryansh5545 commented 4 years ago

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

Selection_062

yashdusing commented 4 years ago

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

Suryansh5545 commented 4 years ago

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 commented 4 years ago

@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 commented 4 years ago

Should I work on using sphinx rtx theme?

Suryansh5545 commented 4 years ago

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 commented 4 years ago

Selection_007