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

Update documentation #67

Merged
merged 6 commits into from
Aug 1, 2018
Merged

Conversation

T-Nicholls
Copy link
Collaborator

Changes;

  • made cothread's association with EPICS clearer under installation in examples.rst
  • removed an unnecessary line of equals signs above the title in examples.rst
  • removed developer specific steps from installation and initialisation sectiond of examples.rst
  • created developers.rst and populated it with the developer specific installation and initialisation steps.
  • added the developers page to the contents list in index.rst

@coveralls
Copy link

coveralls commented Jul 11, 2018

Coverage Status

Coverage increased (+0.2%) to 94.541% when pulling 2fc1b46 on T-Nicholls:docChanges into c7efcd6 on willrogers:master.

- Install dev-packages, pytac, and cothread for EPICS support::

$ pipenv install --dev
$ pip install pytac
Copy link
Collaborator

Choose a reason for hiding this comment

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

You don't need to install pytac here because you will be using the version in the repo. This is why you got the strange behaviour when you were trying to build the documentation.

@@ -7,24 +6,22 @@ Installation

This is only required on your first use.

- Ensure you have the following requirements: Pip, Pipenv, and a local copy of pytac.
- Ensure you have Pip and a local copy of pytac.
Copy link
Collaborator

Choose a reason for hiding this comment

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

You don't need a local copy of Pytac this time - you're downloading it from PyPI

@T-Nicholls
Copy link
Collaborator Author

Corrected and pushed the corrections mentioned above.

@willrogers willrogers merged commit 3c7cfe8 into DiamondLightSource:master Aug 1, 2018
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