-
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
[WIP] Initial docs #59
base: master
Are you sure you want to change the base?
Conversation
Give me till tonight. I want to try this on my system before I put in a full-fledged review. |
@varunagrawal I don't think these autodocs would be much use as it is, we have to revamp the existing docs. Please check #62 That's where I typed the docs |
@isht3 Can you please break this into two PR's:
|
@RishabhJain2018 Done! |
docs/conf.py
Outdated
# -- Project information ----------------------------------------------------- | ||
|
||
project = u'EvalAI CLI' | ||
copyright = u'2018, Adarsh S' |
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.
Please change it to 2018, CloudCV
docs/conf.py
Outdated
|
||
project = u'EvalAI CLI' | ||
copyright = u'2018, Adarsh S' | ||
author = u'Adarsh S' |
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.
Please change it to CloudCV Team
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.
@isht3 Please update it too!
@@ -0,0 +1,2 @@ | |||
Sphinx==1.7.5 |
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.
Please add it in requirements/dev.txt
So, now the directory structure would be requirements/
(which is a folder), requirements/common.txt
, requirements/dev.txt
, requirements/prod.txt
.
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.
Since the production settings are already mentioned at setup.py
I don't think we need a prod.txt
. And these settings are only needed for working on the docs, so is it right to put it in the dev.txt
?
@isht3 Is this PR Complete? |
@RishabhJain2018 The configurations are correct but this can only be completely generated after the PR #87 is merged. |
No description provided.