-
Notifications
You must be signed in to change notification settings - Fork 63
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
base: master
Are you sure you want to change the base?
Conversation
Also the person creating or editing will require the edited theme so that it look similar to old one. |
@Suryansh5545 could you add the screenshot to the list of commands ? |
Also, add the procedure to create the docs in the PR and the readme if possible |
@Ram81 @pushkalkatara @RishabhJain2018 please review |
@Suryansh5545 Could you please work on the spacing between the html elements ? |
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 Please try to improve the theme. Maybe you can work on to get the previous one. 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? |
Should I work on using sphinx rtx theme? |
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 💯
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:-
Expected:-