Skip to content

Commit 7933a4d

Browse files
committed
redesign documentation and cleanup docstrings
Several elements from the new documentation have been inspired or outright stolen from Plumbum's excellent landing page.
1 parent c222931 commit 7933a4d

25 files changed

+302
-143
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ TAGS
1414
evdev/*.so
1515
evdev/ecodes.c
1616
doc/_build
17+
.#*
1718
__pycache__
1819

1920
evdev/_ecodes.py

doc/Makefile

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,12 @@ help:
4141
clean:
4242
-rm -rf $(BUILDDIR)/*
4343

44+
4445
html:
4546
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
4647
@echo
4748
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
49+
@sed -i $(BUILDDIR)/html/index.html -e 's,<span>Synopsis</span>,<span>Python Bindings</span>,'
4850

4951
dirhtml:
5052
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@@ -152,6 +154,13 @@ doctest:
152154
@echo "Testing of doctests in the sources finished, look at the " \
153155
"results in $(BUILDDIR)/doctest/output.txt."
154156

157+
158+
# .PHONY: news.rst
159+
# news.rst: changelog.rst
160+
# cat $< | grep -FB1 '^^^^^^^^^' \
161+
# | sed -e '/^\^/d;/--/d' -e 's,\(.*\)(\(.*\)),* **\2**: Version \1released.\n,' \
162+
# > $@
163+
155164
$(BUILDDIR)/html/evdev-doc.zip: html
156165
cd $(BUILDDIR)/html/ && zip -x \*.zip -r evdev-doc.zip .
157166
@echo `readlink -f $@`

doc/_static/evdev-logo-small.png

5.77 KB
Loading

doc/_static/evdev-logo.png

4.31 KB
Loading

doc/_static/github-logo.png

12.7 KB
Loading
2.71 KB
Loading
2.87 KB
Loading
3.1 KB
Loading
3.29 KB
Loading
3.12 KB
Loading

0 commit comments

Comments
 (0)