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

Create sphinx documentation #285

Merged
merged 1 commit into from
Jul 28, 2017

Conversation

DavidKnott
Copy link
Contributor

The goal of this PR is to facilitate contributions to the docs by creating a base starting point (using sphinx and recommonmark ).
To runs the docs locally enter:

  1. pip install -r requirements-docs.txt
  2. make docs
    @yograterol

docs/conf.py Outdated
# ones.
extensions = [
'sphinx.ext.autodoc'
]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PEP8,

extensions = [
    'sphinx.ext.autodoc'
]

@yograterol
Copy link
Contributor

@DavidKnott I see this good, just solve the conflicts. We could create an issue with the points to document and hand out the tasks.

@yograterol
Copy link
Contributor

image

👍

@DavidKnott
Copy link
Contributor Author

@yograterol I fixed the conflicts and the styling. Good thinking, let's split up the doc work into manageable issues.

@DavidKnott DavidKnott mentioned this pull request Jul 28, 2017
@vbuterin vbuterin merged commit c4deae4 into vyperlang:master Jul 28, 2017
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.

3 participants