Skip to content

Commit 2e622c8

Browse files
authored
Merge branch 'master' into noindexentry
2 parents dd32554 + f9ab996 commit 2e622c8

File tree

4 files changed

+96
-89
lines changed

4 files changed

+96
-89
lines changed

README.rst

Lines changed: 4 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -36,94 +36,16 @@ PHP Domain supports following objects:
3636

3737
Package\Subpackage\Class
3838

39+
See `Usage Example`_ in the documentation for information about how to use it.
40+
41+
.. _`Usage Example`: https://markstory.github.io/sphinxcontrib-phpdomain/usage.html
42+
3943
URLs
4044
====
4145

4246
:PyPI: https://pypi.python.org/pypi/sphinxcontrib-phpdomain
4347
:Documentation: https://markstory.github.io/sphinxcontrib-phpdomain/
4448

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-
:noindexentry:
82-
:nocontentsentry:
83-
84-
Datetime class
85-
86-
.. php:method:: setDate($year, $month, $day)
87-
:noindexentry:
88-
:nocontentsentry:
89-
90-
Set the date.
91-
92-
:param int $year: The year.
93-
:param int $month: The month.
94-
:param int $day: The day.
95-
:returns: Either false on failure, or the DateTime object for method chaining.
96-
97-
98-
.. php:method:: setTime($hour, $minute[, $second])
99-
:noindexentry:
100-
:nocontentsentry:
101-
102-
Set the time.
103-
104-
:param int $hour: The hour
105-
:param int $minute: The minute
106-
:param int $second: The second
107-
:returns: Either false on failure, or the DateTime object for method chaining.
108-
109-
.. php:const:: ATOM
110-
:noindexentry:
111-
:nocontentsentry:
112-
113-
Y-m-d\TH:i:sP
114-
115-
Cross referencing
116-
-----------------
117-
118-
From other place, you can create cross reference like that::
119-
120-
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
121-
122-
Result
123-
-----------
124-
125-
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
126-
12749
Install
12850
=======
12951

doc/changes.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
ChangeLog
2+
#########
3+
4+
.. include:: ../CHANGES
5+
6+

doc/index.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
.. include:: ../README.rst
22

3-
Contents:
4-
---------
3+
Contents
4+
========
55

66
.. toctree::
77
:maxdepth: 2
88

9+
usage
910
reference
11+
changes
1012

1113
* :ref:`genindex`
1214
* :ref:`search`
1315

14-
ChangeLog
15-
=========
16-
17-
.. include:: ../CHANGES
18-

doc/usage.rst

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
Usage Example
2+
=============
3+
4+
This is source:
5+
6+
.. code:: rst
7+
8+
.. php:class:: DateTime
9+
10+
Datetime class
11+
12+
.. php:method:: setDate($year, $month, $day)
13+
14+
Set the date.
15+
16+
:param int $year: The year.
17+
:param int $month: The month.
18+
:param int $day: The day.
19+
:returns: Either false on failure, or the datetime object for method chaining.
20+
21+
22+
.. php:method:: setTime($hour, $minute[, $second])
23+
24+
Set the time.
25+
26+
:param int $hour: The hour
27+
:param int $minute: The minute
28+
:param int $second: The second
29+
:returns: Either false on failure, or the datetime object for method chaining.
30+
31+
.. php:const:: ATOM
32+
33+
Y-m-d\TH:i:sP
34+
35+
Result
36+
-----------------
37+
38+
.. php:class:: DateTime
39+
:nocontentsentry:
40+
41+
Datetime class
42+
43+
.. php:method:: setDate($year, $month, $day)
44+
:nocontentsentry:
45+
46+
Set the date.
47+
48+
:param int $year: The year.
49+
:param int $month: The month.
50+
:param int $day: The day.
51+
:returns: Either false on failure, or the DateTime object for method chaining.
52+
53+
54+
.. php:method:: setTime($hour, $minute[, $second])
55+
:nocontentsentry:
56+
57+
Set the time.
58+
59+
:param int $hour: The hour
60+
:param int $minute: The minute
61+
:param int $second: The second
62+
:returns: Either false on failure, or the DateTime object for method chaining.
63+
64+
.. php:const:: ATOM
65+
:nocontentsentry:
66+
67+
Y-m-d\TH:i:sP
68+
69+
Cross referencing
70+
-----------------
71+
72+
From other place, you can create cross reference like that:
73+
74+
.. code:: rst
75+
76+
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
77+
78+
Result
79+
-----------
80+
81+
You can modify a DateTime's date using :php:meth:`DateTime::setDate`.
82+

0 commit comments

Comments
 (0)