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

[WIP] Initial docs #59

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

[WIP] Initial docs #59

wants to merge 3 commits into from

Conversation

guyandtheworld
Copy link
Member

@guyandtheworld guyandtheworld commented Jun 27, 2018

No description provided.

@varunagrawal
Copy link
Contributor

Give me till tonight. I want to try this on my system before I put in a full-fledged review.

@guyandtheworld
Copy link
Member Author

@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

@guyandtheworld guyandtheworld changed the title Add auto generated docs from the docstrings (Sphinx-Autodocs) [WIP] Add auto generated docs from the docstrings (Sphinx-Autodocs) Jul 3, 2018
@guyandtheworld guyandtheworld changed the title [WIP] Add auto generated docs from the docstrings (Sphinx-Autodocs) [WIP] Initial docs and landing page. Jul 4, 2018
@RishabhJain2018
Copy link
Member

@isht3 Can you please break this into two PR's:

  1. Containing the landing page only.
  2. Containing the sphinx settings and it's related settings.
    This way we can the merge the landing page for now and then sphinx part later on when it is completed.

@guyandtheworld guyandtheworld changed the title [WIP] Initial docs and landing page. [WIP] Initial docs Jul 7, 2018
@guyandtheworld
Copy link
Member Author

@RishabhJain2018 Done!

docs/conf.py Outdated
# -- Project information -----------------------------------------------------

project = u'EvalAI CLI'
copyright = u'2018, Adarsh S'
Copy link
Member

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'
Copy link
Member

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

Copy link
Member

@RishabhJain2018 RishabhJain2018 left a 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
Copy link
Member

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.

Copy link
Member Author

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?

@RishabhJain2018
Copy link
Member

@isht3 Is this PR Complete?

@guyandtheworld
Copy link
Member Author

@RishabhJain2018 The configurations are correct but this can only be completely generated after the PR #87 is merged.

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.

4 participants