Skip to content

Commit 560c31f

Browse files
committed
Fix docs generation
1 parent 5f09081 commit 560c31f

6 files changed

Lines changed: 9 additions & 10 deletions

File tree

docs/bands_example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Exporting band data
44
.. index:: ENVISAT, band, raster
55

66
This tutorial shows how to convert ENVISAT_ raster information from dataset
7-
and generate flat binary rasters using PyEPR_.
7+
and generate flat binary (raster) files using PyEPR_.
88

99
The program generates as many raster as the dataset specified in input.
1010

docs/gdal_export_example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ It is a description of a raster file that the GDAL_ library uses for low level
7979
data access.
8080
Of course the entire machinery works because data in :class:`epr.Band`\s and
8181
:class:`epr.Dataset`\ s of ENVISAT_ products are stored as contiguous
82-
rasters.
82+
raster files.
8383

8484
.. raw:: latex
8585

docs/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,6 @@ ENVISAT Product Reader Python API
5252
* `CI status page <https://github.com/avalentino/pyepr/actions>`_
5353
* `PyEPR project page on PyPi <http://pypi.python.org/pypi/pyepr>`_
5454
* EPR-API `project page <https://github.com/bcdev/epr-api>`_
55-
* EPR-API `documentation
56-
<https://rawgithub.com/bcdev/epr-api/master/docs/epr_c_api/index.html>`_
5755

5856
__ PyEPR_
5957

@@ -108,6 +106,6 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
108106
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
109107
GNU General Public License for more details.
110108
You should have received a copy of the GNU General Public License
111-
along with PyEPR. If not, see <http://www.gnu.org/licenses/>.
109+
along with PyEPR. If not, see <https://www.gnu.org/licenses/>.
112110

113-
.. _`GNU General Public License`: http://www.gnu.org/licenses/gpl-3.0.html
111+
.. _`GNU General Public License`: https://www.gnu.org/licenses/gpl-3.0.html

docs/interactive_use.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ Dealing with image data is simple as well::
311311
.. figure:: images/ASA_IMP_crop.*
312312
:width: 100%
313313

314-
Image data read from the "proc_data" band
314+
Image data read from the `proc_data`` band
315315

316316

317317
.. _iterable: https://docs.python.org/3/glossary.html#term-iterable

docs/spelling_wordlist.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ api
22
config
33
constness
44
Cythonizing
5+
de
56
dev
67
distutils
78
docstrings
@@ -31,7 +32,9 @@ roduct
3132
scanline
3233
sdist
3334
src
35+
str
3436
toml
3537
uchar
3638
vapour
3739
unittests
40+
vectorized

docs/usermanual.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Python vs C API
229229
---------------
230230

231231
The Python_ EPR API is fully object oriented.
232-
The main structures of the `C API`_ have been implemented as objects while
232+
The main structures of the C API have been implemented as objects while
233233
C function have been logically grouped and mapped onto object methods.
234234

235235
The entire process of defining an object oriented API for Python_ has
@@ -239,8 +239,6 @@ API,
239239
Of course there are also some differences that are illustrated in the
240240
following sections.
241241

242-
.. _`C API`: https://rawgit.com/bcdev/epr-api/master/docs/epr_c_api/index.html
243-
244242

245243
.. index:: memory, product
246244
pair: allocation; de-allocation

0 commit comments

Comments
 (0)