Skip to content

Commit

Permalink
modify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kepbod committed Nov 19, 2016
1 parent d80b174 commit c489673
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: clean clean-build clean-pyc clean-test lint test docs
.PHONY: clean clean-build clean-pyc clean-test lint test test-doc docs

help:
@echo "clean - remove all build, test, coverage and Python artifacts"
Expand All @@ -7,6 +7,7 @@ help:
@echo "clean-test - remove test and coverage artifacts"
@echo "lint - check style with flake8"
@echo "test - run tests quickly with the default Python"
@echo "test-doc - run Sphinx documentation integrity check"
@echo "docs - generate Sphinx HTML documentation, including API docs"

clean: clean-build clean-pyc clean-test
Expand All @@ -33,6 +34,9 @@ lint:
test:
pytest pydev

test-doc:
sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html

docs:
rm -f docs/pydev.rst
rm -f docs/modules.rst
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![readthedocs](https://readthedocs.org/projects/pydev/badge/?version=latest)](http://pydev.readthedocs.io/en/latest/?badge=latest)

[pytest](http://pytest.org)(pytest is a very popular python testing framework): [pytest branch](https://github.com/kepbod/pydev/tree/master)
* [Travis CI](https://travis-ci.org): [![travis-ci](https://travis-ci.org/kepbod/pydev.svg?branch=master)](https://travis-ci.org/kepbod/pydev)
* [Codecov](https://codecov.io): [![codecov](https://codecov.io/gh/kepbod/pydev/branch/master/graph/badge.svg)](https://codecov.io/gh/kepbod/pydev/branch/master)
Expand Down
3 changes: 0 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,7 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
]

Expand Down

0 comments on commit c489673

Please sign in to comment.