@@ -77,7 +77,7 @@ Requirements
77
77
^^^^^^^^^^^^
78
78
79
79
To build the pandas docs there are some extra requirements: you will need to
80
- have ``sphinx `` and ``ipython `` installed. `numpydoc
80
+ have ``sphinx `` and ``ipython `` installed. `numpydoc
81
81
<https://github.com/numpy/numpydoc> `_ is used to parse the docstrings that
82
82
follow the Numpy Docstring Standard (see above), but you don't need to install
83
83
this because a local copy of ``numpydoc `` is included in the pandas source
@@ -89,7 +89,7 @@ installed. This is not needed, but be aware that you will see some error
89
89
messages. Because all the code in the documentation is executed during the doc
90
90
build, the examples using this optional dependencies will generate errors.
91
91
Run ``pd.show_version() `` to get an overview of the installed version of all
92
- dependencies.
92
+ dependencies.
93
93
94
94
.. warning ::
95
95
@@ -135,12 +135,21 @@ If you want to do a full clean build, do::
135
135
136
136
Staring with 0.13.1 you can tell ``make.py `` to compile only a single section
137
137
of the docs, greatly reducing the turn-around time for checking your changes.
138
+ You will be prompted to delete unrequired `.rst ` files, since the last commited
139
+ version can always be restored from git.
138
140
139
- python make.py --no-api # omit autosummary and api section
140
- python make.py --single indexing # compile the docs with only a single
141
- # section, that which is in indexing.rst
141
+ ::
142
142
143
- For comparision, a full doc build may take 10 minutes. a ``-no-api `` build
143
+ #omit autosummary and api section
144
+ python make.py clean
145
+ python make.py --no-api
146
+
147
+ # compile the docs with only a single
148
+ # section, that which is in indexing.rst
149
+ python make.py clean
150
+ python make.py --single indexing
151
+
152
+ For comparison, a full doc build may take 10 minutes. a ``-no-api `` build
144
153
may take 3 minutes and a single section may take 15 seconds.
145
154
146
155
Where to start?
0 commit comments