Skip to content

Commit 06204ae

Browse files
markstorymarkstory
committed
Import from shared hg repo.
Working with the shared hg repo is generally more work for me, as I don't get notifications on issues or pull requests. Having a standalone repo will make maintenance a bit easier.
0 parents  commit 06204ae

19 files changed

+2488
-0
lines changed

‎CHANGES

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
0.1.4
2+
=====
3+
4+
* Added support for traits.
5+
6+
0.1.3
7+
=====
8+
9+
* Fixed issues with global functions getting nested inside classes that preceded them.
10+
* Fixed static methods being omitted from the index.
11+
* Interface support added (thanks heavenshell).
12+
13+
0.1.2
14+
=====
15+
16+
* Made it possible to not require class properties to be nested under the
17+
class definition.
18+
* Added ``.. php:staticmethod:`` to solve ambiguity in method naming.
19+
* Added prefixes for a number of things, and removed classname as a prefix for
20+
indented class constants.
21+
22+
0.1.1
23+
=====
24+
25+
* Fixed issues with constant documentation.
26+
27+
0.1.0
28+
=====
29+
30+
* Initial release.

‎LICENSE

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
If not otherwise noted, the extensions in this package are licensed
2+
under the following license.
3+
4+
Copyright (c) 2010 by the contributors (see AUTHORS file).
5+
All rights reserved.
6+
7+
Redistribution and use in source and binary forms, with or without
8+
modification, are permitted provided that the following conditions are
9+
met:
10+
11+
* Redistributions of source code must retain the above copyright
12+
notice, this list of conditions and the following disclaimer.
13+
14+
* Redistributions in binary form must reproduce the above copyright
15+
notice, this list of conditions and the following disclaimer in the
16+
documentation and/or other materials provided with the distribution.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22+
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25+
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26+
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎MANIFEST.in

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
include README
2+
include LICENSE
3+
include CHANGES

‎README.rst

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
PHP Domain
2+
##########
3+
4+
:author: Mark Story <mark at mark-story.com>
5+
6+
About
7+
=====
8+
9+
A domain for sphinx >= 1.0 that provides language support for PHP.
10+
11+
PHP Domain supports following objects:
12+
13+
* Global variable
14+
* Global function
15+
* Constant
16+
* Namespace
17+
18+
* Function
19+
* Class
20+
21+
* Class
22+
23+
* Class constant
24+
* Instance methods
25+
* Static methods
26+
* Properties
27+
28+
.. note::
29+
30+
This domain expresses methods and attribute names like this::
31+
32+
Class::method_name
33+
Class::$attribute_name
34+
35+
You address classes/functions in namespaces using \\ syntax as you would in PHP::
36+
37+
Package\Subpackage\Class
38+
39+
URLs
40+
====
41+
42+
:PyPI: http://pypi.python.org/pypi/sphinxcontrib-phpdomain
43+
:Detail Document: http://packages.python.org/sphinxcontrib-phpdomain
44+
45+
Quick Sample
46+
============
47+
48+
This is source::
49+
50+
.. php:class:: DateTime
51+
52+
Datetime class
53+
54+
.. php:method:: setDate($year, $month, $day)
55+
56+
Set the date.
57+
58+
:param int $year: The year.
59+
:param int $month: The month.
60+
:param int $day: The day.
61+
:returns: Either false on failure, or the datetime object for method chaining.
62+
63+
64+
.. php:method:: setTime($hour, $minute[, $second])
65+
66+
Set the time.
67+
68+
:param int $hour: The hour
69+
:param int $minute: The minute
70+
:param int $second: The second
71+
:returns: Either false on failure, or the datetime object for method chaining.
72+
73+
.. php:const:: ATOM
74+
75+
Y-m-d\TH:i:sP
76+
77+
Result
78+
-----------------
79+
80+
.. php:class:: DateTime
81+
82+
Datetime class
83+
84+
.. php:method:: setDate($year, $month, $day)
85+
86+
Set the date.
87+
88+
:param int $year: The year.
89+
:param int $month: The month.
90+
:param int $day: The day.
91+
:returns: Either false on failure, or the DateTime object for method chaining.
92+
93+
94+
.. php:method:: setTime($hour, $minute[, $second])
95+
96+
Set the time.
97+
98+
:param int $hour: The hour
99+
:param int $minute: The minute
100+
:param int $second: The second
101+
:returns: Either false on failure, or the DateTime object for method chaining.
102+
103+
.. php:const:: ATOM
104+
105+
Y-m-d\TH:i:sP
106+
107+
Cross referencing
108+
-----------------
109+
110+
From other place, you can create cross reference like that::
111+
112+
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
113+
114+
Result
115+
-----------
116+
117+
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
118+
119+
Install
120+
=======
121+
122+
You can install the phpdomain using easy_install::
123+
124+
easy_install -U sphinxcontrib-phpdomain
125+

‎doc/Makefile

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14+
15+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16+
17+
help:
18+
@echo "Please use \`make <target>' where <target> is one of"
19+
@echo " html to make standalone HTML files"
20+
@echo " dirhtml to make HTML files named index.html in directories"
21+
@echo " singlehtml to make a single large HTML file"
22+
@echo " pickle to make pickle files"
23+
@echo " json to make JSON files"
24+
@echo " htmlhelp to make HTML files and a HTML help project"
25+
@echo " qthelp to make HTML files and a qthelp project"
26+
@echo " devhelp to make HTML files and a Devhelp project"
27+
@echo " epub to make an epub"
28+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
30+
@echo " text to make text files"
31+
@echo " man to make manual pages"
32+
@echo " changes to make an overview of all changed/added/deprecated items"
33+
@echo " linkcheck to check all external links for integrity"
34+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
35+
36+
clean:
37+
-rm -rf $(BUILDDIR)/*
38+
39+
html:
40+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
41+
@echo
42+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43+
44+
dirhtml:
45+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48+
49+
singlehtml:
50+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
51+
@echo
52+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
53+
54+
pickle:
55+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
56+
@echo
57+
@echo "Build finished; now you can process the pickle files."
58+
59+
json:
60+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
61+
@echo
62+
@echo "Build finished; now you can process the JSON files."
63+
64+
htmlhelp:
65+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
66+
@echo
67+
@echo "Build finished; now you can run HTML Help Workshop with the" \
68+
".hhp project file in $(BUILDDIR)/htmlhelp."
69+
70+
qthelp:
71+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
72+
@echo
73+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
74+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
75+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sphinxcontrib-rubydomain-acceptancetest.qhcp"
76+
@echo "To view the help file:"
77+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinxcontrib-rubydomain-acceptancetest.qhc"
78+
79+
devhelp:
80+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
81+
@echo
82+
@echo "Build finished."
83+
@echo "To view the help file:"
84+
@echo "# mkdir -p $$HOME/.local/share/devhelp/sphinxcontrib-rubydomain-acceptancetest"
85+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinxcontrib-rubydomain-acceptancetest"
86+
@echo "# devhelp"
87+
88+
epub:
89+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
90+
@echo
91+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
92+
93+
latex:
94+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
95+
@echo
96+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
97+
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
98+
"run these through (pdf)latex."
99+
100+
latexpdf: latex
101+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102+
@echo "Running LaTeX files through pdflatex..."
103+
make -C $(BUILDDIR)/latex all-pdf
104+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105+
106+
text:
107+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108+
@echo
109+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
110+
111+
man:
112+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
113+
@echo
114+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
115+
116+
changes:
117+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
118+
@echo
119+
@echo "The overview file is in $(BUILDDIR)/changes."
120+
121+
linkcheck:
122+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
123+
@echo
124+
@echo "Link check complete; look for any errors in the above output " \
125+
"or in $(BUILDDIR)/linkcheck/output.txt."
126+
127+
doctest:
128+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129+
@echo "Testing of doctests in the sources finished, look at the " \
130+
"results in $(BUILDDIR)/doctest/output.txt."

0 commit comments

Comments
 (0)