Skip to content

Commit

Permalink
Revert "Add and configure sphinx"
Browse files Browse the repository at this point in the history
This reverts commit 1ae8765.

I decided to give up on auto-generated documentation at the end, it's
tremendously overkill for a project of ~200 LoC.

A well written readme by a human, for a human, should be enough.
  • Loading branch information
Giuseppe Lumia committed Nov 14, 2021
1 parent 04e983d commit c38b294
Show file tree
Hide file tree
Showing 8 changed files with 1 addition and 561 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,3 @@ node_modules

# Serverless framework stuff
.serverless

# Sphinx artifacts
docs/build
7 changes: 0 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.PHONY: clean lint fix test coverage covhtml docs

clean: # Remove development artifacts
@printf "Deleting Python artifacts...\n"
@find . -type d -name "__pycache__" -exec rm -rf {} +
Expand Down Expand Up @@ -28,8 +26,3 @@ covhtml: test # Run coverage and open HTML report
@coverage html --fail-under=0
@if command -v xdg-open > /dev/null; then xdg-open htmlcov/index.html; exit 1; fi # Linux
@if command -v open > /dev/null; then open htmlcov/index.html; exit 1; fi # MacOS

docs: # Generate HTML documentation with Sphinx
@sphinx-build docs/source docs/build
@if command -v xdg-open > /dev/null; then xdg-open docs/build/index.html; exit 1; fi # Linux
@if command -v open > /dev/null; then open docs/build/index.html; exit 1; fi # MacOS
1 change: 0 additions & 1 deletion docs/source/README.md

This file was deleted.

39 changes: 0 additions & 39 deletions docs/source/api.rst

This file was deleted.

56 changes: 0 additions & 56 deletions docs/source/conf.py

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/index.rst

This file was deleted.

Loading

0 comments on commit c38b294

Please sign in to comment.