Skip to content
This repository has been archived by the owner on Feb 17, 2022. It is now read-only.

tests: enforce use of sphinx-apidoc #72

Closed
jbenito3 opened this issue Sep 22, 2015 · 0 comments
Closed

tests: enforce use of sphinx-apidoc #72

jbenito3 opened this issue Sep 22, 2015 · 0 comments
Assignees
@jbenito3
Labels
docs
Milestone
v0.5.0

Comments

@jbenito3
Copy link
Member

At the moment the .rst files located under docs/api/* are automatically generated by:

sphinx-apidoc -f -e -o docs/api/ claimstore

we should add to travis a control that will make sure that both, the output of that command and the content of the folder docs/api are the same. A simple git diff on that specific folder could be a solution.
@jbenito3 jbenito3 added the docs label Sep 22, 2015
@jbenito3 jbenito3 added this to the someday milestone Sep 22, 2015
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 22, 2015
@jbenito3
tests: check sphinx-apidoc output
9ed7f09 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 22, 2015
@jbenito3
tests: check sphinx-apidoc output
e19deea 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 22, 2015
@jbenito3
tests: check sphinx-apidoc output
ed9cb7d 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 22, 2015
@jbenito3
tests: check sphinx-apidoc output
386d2c3 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 22, 2015
@jbenito3
tests: check sphinx-apidoc output
da9c27d 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
@jbenito3 jbenito3 self-assigned this Sep 22, 2015
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
8cc913e 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
0c7dfa1 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
e021492 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
d5d678f 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
da6ef31 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
08ae270 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
6e10c57 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
3c6920f 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
e65ae7d 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
45fa13f 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
ca2bd64 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
aef35a6 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
f87db8e 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
464bab6 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
jbenito3 added a commit to jbenito3/claimstore that referenced this issue Sep 23, 2015
@jbenito3
tests: check sphinx-apidoc output
2e0a854 
* Checks that `spinhx-apidoc` has been run and the output matches what
  is in `docs/api/*`. (closes inveniosoftware#72)

Signed-off-by: Jose Benito Gonzalez Lopez <jose.benito.gonzalez@cern.ch>
@jbenito3 jbenito3 modified the milestones: v0.5.0, someday Sep 23, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jbenito3 jbenito3

Labels
docs
Projects
None yet
Milestone
v0.5.0
Development

No branches or pull requests
1 participant
@jbenito3