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

Remove docs #322

Merged
merged 1 commit into from
Nov 3, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 1 addition & 22 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,6 @@ clean-pyc: ## remove Python file artifacts
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +

.PHONY: clean-docs
clean-docs: ## remove previously built docs
rm -f docs/api/*.rst
-$(MAKE) -C docs clean 2>/dev/null # this fails if sphinx is not yet installed

.PHONY: clean-coverage
clean-coverage: ## remove coverage artifacts
rm -f .coverage
Expand All @@ -64,7 +59,7 @@ clean-test: ## remove test artifacts
rm -fr .pytest_cache

.PHONY: clean
clean: clean-build clean-pyc clean-test clean-coverage clean-docs ## remove all build, test, coverage, docs and Python artifacts
clean: clean-build clean-pyc clean-test clean-coverage ## remove all build, test, coverage and Python artifacts


# INSTALL TARGETS
Expand Down Expand Up @@ -135,22 +130,6 @@ coverage: ## check code coverage quickly with the default Python
$(BROWSER) htmlcov/index.html


# DOCS TARGETS

.PHONY: docs
docs: clean-docs ## generate Sphinx HTML documentation, including API docs
sphinx-apidoc --separate --no-toc -o docs/api/ rdt
$(MAKE) -C docs html

.PHONY: view-docs
view-docs: docs ## view docs in browser
$(BROWSER) docs/_build/html/index.html

.PHONY: serve-docs
serve-docs: view-docs ## compile the docs watching for changes
watchmedo shell-command -W -R -D -p '*.rst;*.md' -c '$(MAKE) -C docs html' docs


# RELEASE TARGETS

.PHONY: dist
Expand Down
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

1 change: 0 additions & 1 deletion docs/authors.rst

This file was deleted.

196 changes: 0 additions & 196 deletions docs/conf.py

This file was deleted.

1 change: 0 additions & 1 deletion docs/contributing.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/history.rst

This file was deleted.

Binary file removed docs/images/dai-logo-white-200.png
Binary file not shown.
Binary file removed docs/images/dai-logo-white.ico
Binary file not shown.
Binary file removed docs/images/rdt-logo.png
Binary file not shown.
22 changes: 0 additions & 22 deletions docs/index.rst

This file was deleted.

36 changes: 0 additions & 36 deletions docs/make.bat

This file was deleted.

1 change: 0 additions & 1 deletion docs/readme.rst

This file was deleted.

6 changes: 0 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,6 @@
'pip>=9.0.1',
'watchdog>=0.8.3,<0.11',

# docs
'm2r>=0.2.0,<0.3',
'Sphinx>=1.7.1,<3',
'sphinx_rtd_theme>=0.2.4,<0.5',
'autodocsumm>=0.1.10',

# style check
'pycodestyle<2.8.0,>=2.7.0',
'pyflakes<2.4.0,>=2.3.0',
Expand Down