Skip to content
This repository has been archived by the owner on Oct 4, 2020. It is now read-only.

Add Sphinx documentation #13

Closed

Conversation

SamWhited
Copy link
Member

Adds some sphinx documentation (and a makefile rule to generate it). To generate the docs run:

make docs

This will also be run by Travis.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling f53efc4 on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

2 similar comments
@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling f53efc4 on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling f53efc4 on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling f53efc4 on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@@ -2,3 +2,5 @@ coverage
flake8
pytest
tox
sphinx
Copy link
Member

Choose a reason for hiding this comment

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

Why is sphinx needed for tests?

Copy link
Member Author

Choose a reason for hiding this comment

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

On May 18, 2015 7:37:32 PM CDT, Cameron Paul notifications@github.com wrote:

@@ -2,3 +2,5 @@ coverage
flake8
pytest
tox
+sphinx

Why is sphinx needed for tests?


Reply to this email directly or view it on GitHub:
https://github.com/photoshell/rawkit/pull/13/files#r30560405

Travis builds the docs now to make sure we don't break them.

Sam Whited
pub 4096R/54083AE104EA7AD3

@campaul
Copy link
Member

campaul commented May 19, 2015

make docs fails if you don't manually install sphinx right now.

@SamWhited
Copy link
Member Author

Odd, it should be using the one out of your venv. I'll take a look at it.

@SamWhited
Copy link
Member Author

Seems to work for me (uninstalled sphinx, git clean -dxf-ed, and ran make docs).

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 26f49b5 on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 43c0074 on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 30ddf7f on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 30ddf7f on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling aaef85c on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 957aacb on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 957aacb on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 9999f6f on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 0.0% when pulling 9999f6f on SamWhited:issue11-write-documentation into 53ee0f6 on photoshell:master.

@SamWhited
Copy link
Member Author

Squashed and merged.

@SamWhited SamWhited closed this May 19, 2015
@SamWhited SamWhited deleted the issue11-write-documentation branch February 17, 2018 22:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants