Permalink
Browse files

Added auto doc generation

- added sphinx configuration to create documentation from docstrings
- fixed some sphinx warnings in docstrings
- added script that recreates documentation after each commit and commit it to gh-pages
- added mention of pyfakefs version for newer features in docstrings
  • Loading branch information...
mrbean-bremen committed Nov 24, 2016
1 parent cf5f9f5 commit ff973be32e1c531795353e168ef43a3b347fa3c1
View
@@ -23,8 +23,16 @@ python:
- "3.5"
- "3.6-dev"
env:
global:
secure: o3gp5nDx3ZCtmDqDEIq9iqE7UHoQyWXTDUKG6CjJWxQVDhcIoxGbqyNaa2dW3koxWwyEqXb95DjF1mSDd6rh7V5eSa444dk0lMJbda95EKyk/kToJQsGYIqf6tFZ4snRt7/SuiZB5WkDdPOWmaQpCdii45Mj0beTgbvfQHfDfZ+ECWNB3OBU4z3JBC3ybPThCyDP1npaGgKLFiEyAAbhR0enLy0ztGfKJ2KLc8/s2sM+IbAYW3+Y7kLiK3UxL1nFhujqXvV61+eLdK0349OuwFFCmpd+4Cec5ZSLdeXceWEPFioUkxZS5sRUokodA94pr1h3kpo4i+/7tr+bO1BatkbVCr8bxZeRnDRYamWXs8AlejlrTXmVk7+BN4Dzsu+hzLHIpyJlJfEef8WQNvxbgJAlW0q/VrStO/209/CML2jiV7D7CTY9hAVdlZ4GNlUQFOXcPk1npHWpjmFmwahAi7oVTvSzFDWFRZoW0jcRPQIunXG5NXpCimgQPE3+/+GhXWhvjbyTog815GOntxszkpL9/hq97LK3sFjE0ebkf74o7HVZDhorRR0z+TaY4Gb94AjxlYUrsYGPVvnX5KbxBTFFEMC0veJCqns3NqV3zhAR4oHIZbujWEft/zRI+WEVd4EZmlYXOe6CvQtIYX8GdOC49h8KPvLwS7XzSP16PJY=
install:
- if [[ $TRAVIS_PYTHON_VERSION == 2.6 ]]; then pip install importlib unittest2; fi
- pip install -r requirements.txt
script: ./all_tests.py
after_success:
- pip install sphinx
- ./build-docs.sh
View
@@ -1,12 +1,12 @@
# Release Notes
The release versions are PyPi releases.
## Unreleased
## Version 3.0 (unreleased)
#### New Features
* support for path-like objects as arguments in fake os
and os.path modules (Python >= 3.6)
* support for `pathlib` (Python >= 3.4)
* support for path-like objects as arguments in fake `os`
and `os.path` modules (Python >= 3.6)
* support for `pathlib` module (Python >= 3.4)
* support for `os.replace` (Python >= 3.3)
* `os.access`, `os.chmod`, `os.chown`, `os.stat`, `os.utime`:
support for `follow_symlinks` argument (Python >= 3.3)
@@ -15,6 +15,9 @@ The release versions are PyPi releases.
* `glob.glob`, `glob.iglob`: support for `recursive` argument (Python >= 3.5)
* support for `glob.iglob`
#### Fixes
* Exception handling when using `Patcher` with py.test (#135)
## Version 2.9
#### New Features
View
@@ -5,6 +5,8 @@ touching the real disk. The software under test requires no modification to
work with pyfakefs.
pyfakefs works with Linux, Windows and MacOS.
Auto-generated documentation for the current version can be found [here](http://jmcgeheeiv.github.io/pyfakefs/).
For an overview over changes in last versions of pyfakefs look [here](CHANGES.md).
## Usage
There are two approaches to implementing tests using pyfakefs.
View
@@ -0,0 +1,53 @@
#!/bin/bash
# Create html documentation from docstrings using sphinx
# and check it into gh-pages branch using the same commit message.
# Skipped if not the master branch, triggered by a pull request,
# or the string SKIP-AUTODOC appears in the commit message.
# only process after the last matrix build
if [ "$TRAVIS_PYTHON_VERSION" != "3.6-dev" ]; then
exit 0
fi
SOURCE_BRANCH="master"
TARGET_BRANCH="gh-pages"
REPO_URL="https://${GH_TOKEN}@github.com/jmcgeheeiv/pyfakefs.git"
if [ "$TRAVIS_BRANCH" != "$SOURCE_BRANCH" ]; then
echo "Not on $SOURCE_BRANCH branch, skipping"
exit 0
fi
if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
echo "This is a pull request, skipping"
exit 0
fi
# enable error reporting to the console
set -e
# save last commit log - will be used for the doc commit
LAST_COMMIT=`git log -1 --pretty=%B`
if [[ $LAST_COMMIT == *"SKIP-AUTODOC"* ]]; then
echo "Autodoc switched off in commit message, skipping"
exit 0
fi
# create the docs using sphinx
cd docs
make html
cd ..
# clone `gh-pages' branch of the repository using encrypted GH_TOKEN for authentification
git clone $REPO_URL -b $TARGET_BRANCH ../pyfakefs_gh-pages
# copy generated HTML files to `gh-pages' branch
cp gh-pages/*.html ../pyfakefs_gh-pages
cp gh-pages/*.js ../pyfakefs_gh-pages
# commit and push generated content to `gh-pages' branch
cd ../pyfakefs_gh-pages
git config user.name "Travis CI"
git config user.email "pyfakefs@gmail.com"
git commit -a -m "$LAST_COMMIT"
git push --quiet $REPO_URL $TARGET_BRANCH > /dev/null 2>&1
View
@@ -0,0 +1,225 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = ../gh-pages
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyfakefs.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyfakefs.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pyfakefs"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyfakefs"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."
Oops, something went wrong.

0 comments on commit ff973be

Please sign in to comment.