Skip to content

Commit

Permalink
Remove docs directory
Browse files Browse the repository at this point in the history
Let us see if the combination of the README and the demo site has
enough detail to let people know how the app is used. The code is
always the authority so if we can skip adding hard-to-write and
hard-to-maintain documentation that will mean more time for building
stuff.
  • Loading branch information
StuartMacKay committed Sep 30, 2023
1 parent 5717a52 commit d01a9ec
Show file tree
Hide file tree
Showing 14 changed files with 6 additions and 301 deletions.
11 changes: 0 additions & 11 deletions .readthedocs.yml

This file was deleted.

27 changes: 4 additions & 23 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ help:
@echo ""
@echo " help to show this list"
@echo " clean-build to clean the files and directories generated by previous builds"
@echo " clean-docs to clean the generated HTML documentation"
@echo " clean-tests to clean the directories created during testing"
@echo " clean-coverage to clean the test coverage data and reports"
@echo " clean-venv to clean the virtualenv"
Expand All @@ -62,7 +61,6 @@ help:
@echo " build to build the package"
@echo " checks to run quality code checks"
@echo " coverage to measure the test coverage"
@echo " docs to build the HTML documentation"
@echo " install to install the project dependencies in the virtualenv"
@echo " major to update the version number for a major release, e.g. 2.1 to 3.0"
@echo " messages to run the makemessages and compilemessages management commands"
Expand Down Expand Up @@ -93,10 +91,6 @@ clean-build:
rm -rf build
rm -rf src/*.egg-info

.PHONY: clean-docs
clean-docs:
cd docs && make clean

.PHONY: clean-tests
clean-tests:
rm -rf .tox
Expand All @@ -112,7 +106,7 @@ clean-coverage:
rm -rf coverage

.PHONY: clean
clean: clean-venv clean-build clean-tests clean-mypy clean-coverage clean-docs
clean: clean-venv clean-build clean-tests clean-mypy clean-coverage

# ##############
# Virtualenv
Expand All @@ -135,17 +129,14 @@ $(venv_dir):
$(pip) install --upgrade pip setuptools wheel
$(pip) install pip-tools

requirements/dev.txt: requirements/dev.in requirements/docs.in requirements/tests.in
requirements/dev.txt: requirements/dev.in requirements/tests.in
$(pip-compile) requirements/dev.in

requirements/docs.txt: requirements/docs.in
$(pip-compile) requirements/docs.in

requirements/tests.txt: requirements/docs.in requirements/tests.in
requirements/tests.txt: requirements/tests.in
$(pip-compile) requirements/tests.in

.PHONY: requirements
requirements: requirements/dev.txt requirements/docs.txt requirements/tests.txt
requirements: requirements/dev.txt requirements/tests.txt

.PHONY: venv
venv: $(venv_dir) requirements
Expand All @@ -155,7 +146,6 @@ venv: $(venv_dir) requirements
install: venv
$(pip) install --upgrade pip setuptools wheel
$(pip) install pip-tools
test -f requirements/docs.txt || $(pip-compile) requirements/docs.in
test -f requirements/dev.txt || $(pip-compile) requirements/dev.in
test -f requirements/tests.txt || $(pip-compile) requirements/tests.in
$(pip-sync) requirements/dev.txt
Expand Down Expand Up @@ -221,15 +211,6 @@ test:
.PHONY: tox
tox: test
$(tox)
$(tox) -e docs

# ########
# Docs
# ########

.PHONY: docs
docs:
cd docs && make html

# ###########
# Release
Expand Down
2 changes: 0 additions & 2 deletions docs/.gitignore

This file was deleted.

20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

Empty file removed docs/_static/.gitkeep
Empty file.
Empty file removed docs/_templates/.gitkeep
Empty file.
59 changes: 0 additions & 59 deletions docs/conf.py

This file was deleted.

15 changes: 0 additions & 15 deletions docs/index.rst

This file was deleted.

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

This file was deleted.

1 change: 0 additions & 1 deletion requirements/dev.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

-r docs.in
-r tests.in

# Install the app and dependencies for development. It is done this way
Expand Down
48 changes: 2 additions & 46 deletions requirements/dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,12 @@
#
# pip-compile requirements/dev.in
#
-e file:///home/stuart/Development/django-feeds
-e .
# via -r requirements/dev.in
alabaster==0.7.13
# via sphinx
amqp==5.1.1
# via kombu
asgiref==3.7.2
# via django
babel==2.12.1
# via sphinx
beautifulsoup4==4.12.2
# via bs4
billiard==4.1.0
Expand Down Expand Up @@ -82,10 +78,7 @@ django-tagulous==1.3.3
docopt==0.6.2
# via pip-upgrader
docutils==0.18.1
# via
# readme-renderer
# sphinx
# sphinx-rtd-theme
# via readme-renderer
exceptiongroup==1.1.3
# via pytest
factory-boy==3.3.0
Expand All @@ -104,8 +97,6 @@ freezegun==1.2.2
# via pytest-freezegun
idna==3.4
# via requests
imagesize==1.4.1
# via sphinx
importlib-metadata==6.8.0
# via
# keyring
Expand All @@ -122,8 +113,6 @@ jeepney==0.8.0
# via
# keyring
# secretstorage
jinja2==3.1.2
# via sphinx
json-log-formatter==0.5.2
# via -r requirements/dev.in
keyring==24.2.0
Expand All @@ -132,8 +121,6 @@ kombu==5.3.2
# via celery
markdown-it-py==3.0.0
# via rich
markupsafe==2.1.3
# via jinja2
mccabe==0.7.0
# via flake8
mdurl==0.1.2
Expand All @@ -156,7 +143,6 @@ packaging==23.1
# pip-upgrader
# pyproject-api
# pytest
# sphinx
# tox
pathspec==0.11.2
# via black
Expand Down Expand Up @@ -187,7 +173,6 @@ pygments==2.16.1
# via
# readme-renderer
# rich
# sphinx
pyproject-api==1.6.1
# via tox
pytest==7.4.2
Expand Down Expand Up @@ -221,7 +206,6 @@ requests==2.31.0
# -r requirements/dev.in
# pip-upgrader
# requests-toolbelt
# sphinx
# twine
requests-toolbelt==1.0.0
# via twine
Expand All @@ -235,36 +219,8 @@ sgmllib3k==1.0.0
# via feedparser
six==1.16.0
# via python-dateutil
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.5
# via beautifulsoup4
sphinx==7.2.6
# via
# -r requirements/docs.in
# sphinx-rtd-theme
# sphinxcontrib-applehelp
# sphinxcontrib-devhelp
# sphinxcontrib-htmlhelp
# sphinxcontrib-jquery
# sphinxcontrib-qthelp
# sphinxcontrib-serializinghtml
sphinx-rtd-theme==1.3.0
# via -r requirements/docs.in
sphinxcontrib-applehelp==1.0.7
# via sphinx
sphinxcontrib-devhelp==1.0.5
# via sphinx
sphinxcontrib-htmlhelp==2.0.4
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.6
# via sphinx
sphinxcontrib-serializinghtml==1.1.9
# via sphinx
sqlparse==0.4.4
# via
# django
Expand Down
2 changes: 0 additions & 2 deletions requirements/docs.in

This file was deleted.

Loading

0 comments on commit d01a9ec

Please sign in to comment.