Skip to content

Commit ce6344b

Browse files
authored
Merge pull request #7410 from kenjis/fix-docs-documentation.rst
docs: update documentation.rst
2 parents d5b28fd + 7aa526e commit ce6344b

1 file changed

Lines changed: 35 additions & 9 deletions

File tree

contributing/documentation.rst

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,12 @@ Writing CodeIgniter Documentation
33
#################################
44

55
CodeIgniter uses Sphinx to generate its documentation in a variety of formats,
6-
using reStructuredText to handle the formatting. If you are familiar with
6+
using `reStructuredText`_ to handle the formatting. If you are familiar with
77
Markdown or Textile, you will quickly grasp reStructuredText. The focus is
88
on readability and user friendliness.
99
While they can be quite technical, we always write for humans!
1010

11-
A local table of contents should always be included, like the one below.
12-
It is created automatically by inserting the following::
13-
14-
.. contents::
15-
:local:
16-
:depth: 2
11+
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
1712

1813
.. contents::
1914
:local:
@@ -26,7 +21,18 @@ To see the rendered HTML, ePub, PDF, etc., you will need to install Sphinx
2621
along with the PHP domain extension for Sphinx. The underlying requirement
2722
is to have Python installed.
2823

29-
You can read more about installing all tools in /user_guide_src/README.rst
24+
You can read more about installing all tools in **user_guide_src/README.rst**
25+
26+
*****************
27+
Table of Contents
28+
*****************
29+
30+
A local table of contents should always be included, like the one below.
31+
It is created automatically by inserting the following::
32+
33+
.. contents::
34+
:local:
35+
:depth: 2
3036

3137
*****************************************
3238
Page and Section Headings and Subheadings
@@ -119,15 +125,21 @@ You can reference a page like the following::
119125
To a URL
120126
========
121127

128+
::
129+
122130
`CodeIgniter 4 framework <https://github.com/codeigniter4/framework>`_
123131

124132
To a Function
125133
=============
126134

135+
::
136+
127137
:php:func:`dot_array_search()`
128138

129139
To a Method
130-
=============
140+
===========
141+
142+
::
131143

132144
:php:meth:`CodeIgniter\\HTTP\\Response::setCookie()`
133145

@@ -138,10 +150,24 @@ Other Directives
138150
New Feature
139151
===========
140152

153+
::
154+
141155
.. versionadded:: 4.3.0
142156

143157
Deprecated
144158
==========
145159

160+
::
161+
146162
.. deprecated:: 4.3.0
147163
Use :php:meth:`CodeIgniter\\Database\\BaseBuilder::setData()` instead.
164+
165+
***************
166+
Text Decoration
167+
***************
168+
169+
As a general rule, we use ``**`` for in-line file paths, and `````` for source code.
170+
171+
E.g.::
172+
173+
Open the **app/Config/Filters.php** file and update the ``$methods`` property like the following:

0 commit comments

Comments
 (0)