Skip to content

Improve documentation #15

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.

Sign up for GitHub

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

Merged
willrogers merged 2 commits into from
May 25, 2017
Merged

Improve documentation #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c08105d
Tidying up documentation
razvanvasile May 25, 2017
1812c3d
More tidying up
razvanvasile May 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Python Toolkit for Accelerator Controls (Pytac) is a Python library intended to
Testing
=======

It is simplest to work with a virtualenv. Then:
It is simplest to work with a virtualenv. Then::

>>> pip install -r requirements/local.txt
>>> export PYTHONPATH=.
Expand All @@ -23,9 +23,9 @@ To see a coverage report::

>>> py.test --cov=pytac test

To build documentation correctly:
To build documentation correctly::

>>> cd docs`
>>> cd docs
>>> sphinx-build -b html -E . _build/html

The documentation is built inside _build/html.