urbanu619 68fa541fca first commit 10 månader sedan
..
.gitignore 68fa541fca first commit 10 månader sedan
AnnotationLibrary.rst 68fa541fca first commit 10 månader sedan
ConsumingAnnotations.rst 68fa541fca first commit 10 månader sedan
CustomAnnotations.rst 68fa541fca first commit 10 månader sedan
DemoScript.rst 68fa541fca first commit 10 månader sedan
DesignConsiderations.rst 68fa541fca first commit 10 månader sedan
Makefile 68fa541fca first commit 10 månader sedan
README.md 68fa541fca first commit 10 månader sedan
Roadmap.rst 68fa541fca first commit 10 månader sedan
UsingAnnotations.rst 68fa541fca first commit 10 månader sedan
conf.py 68fa541fca first commit 10 månader sedan
getting-started.rst 68fa541fca first commit 10 månader sedan
index.rst 68fa541fca first commit 10 månader sedan

README.md

PHPUnit-Mink Documentation

Preparations

  1. install Sphinx: easy_install -U Sphinx
  2. install Read the Docs Sphinx Theme: pip install sphinx_rtd_theme
  3. install sphinx-autobuild: pip install sphinx-autobuild

Automatic building

  1. run make livehtml in the docs folder
  2. open http://localhost:8000/ to view the documentation

Thanks to the sphinx-autobuild the documentation will be automatically built on every change and all browsers, where it's opened will be reloaded automatically as well.

One-time building

  1. run make html in the docs folder
  2. open docs/build/html folder in your browser