Skip to content

Commit eeb1cfd

Browse files
committed
docs: Fixes to formatting and sphinx warnings (#4301)
Also, tell doxygen to use multiple threads. Signed-off-by: Larry Gritz <[email protected]>
1 parent 73436ab commit eeb1cfd

File tree

4 files changed

+43
-22
lines changed

4 files changed

+43
-22
lines changed

src/doc/Doxyfile

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,27 @@ TYPEDEF_HIDES_STRUCT = NO
440440

441441
LOOKUP_CACHE_SIZE = 0
442442

443+
# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
444+
# during processing. When set to 0 doxygen will based this on the number of
445+
# cores available in the system. You can set it explicitly to a value larger
446+
# than 0 to get more control over the balance between CPU load and processing
447+
# speed. At this moment only the input processing can be done using multiple
448+
# threads. Since this is still an experimental feature the default is set to 1,
449+
# which effectively disables parallel processing. Please report any issues you
450+
# encounter. Generating dot graphs in parallel is controlled by the
451+
# DOT_NUM_THREADS setting.
452+
# Minimum value: 0, maximum value: 32, default value: 1.
453+
454+
NUM_PROC_THREADS = 0
455+
456+
# If the TIMESTAMP tag is set different from NO then each generated page will
457+
# contain the date or date and time when the page was generated. Setting this to
458+
# NO can help when comparing the output of multiple runs.
459+
# Possible values are: YES, NO, DATETIME and DATE.
460+
# The default value is: NO.
461+
462+
TIMESTAMP = NO
463+
443464
#---------------------------------------------------------------------------
444465
# Build related configuration options
445466
#---------------------------------------------------------------------------

src/doc/builtinplugins.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1764,12 +1764,12 @@ attributes are supported:
17641764
- int
17651765
- If nonzero, the PNM file is big-endian (the default is little-endian).
17661766
* - ``pnm:pfmflip``
1767-
- int
1768-
- If this configuration hint is present and is zero, the automatic
1769-
vertical flipping of PFM image will be disabled (i.e., scanline 0 will
1770-
really be the first one stored in the file). If nonzero (the default),
1771-
float PFM files will store scanline 0 as the last scanline in the file
1772-
(i.e. the visual "top" of the image).
1767+
- int
1768+
- If this configuration hint is present and is zero, the automatic
1769+
vertical flipping of PFM image will be disabled (i.e., scanline 0 will
1770+
really be the first one stored in the file). If nonzero (the default),
1771+
float PFM files will store scanline 0 as the last scanline in the file
1772+
(i.e. the visual "top" of the image).
17731773

17741774
**Configuration settings for PNM output**
17751775

@@ -1802,13 +1802,13 @@ control aspects of the writing itself:
18021802
determine whether to write an ASCII or binary file.
18031803
Float PFM files are always written in binary format.
18041804
* - ``pnm:pfmflip``
1805-
- int
1806-
- If this configuration hint is present and is zero, for PFM files,
1807-
scanline 0 will really be stored first in the file, thus disabling the
1808-
usual automatically flipping that accounts for PFM files conventionally
1809-
being stored in bottom-to-top order. If nonzero (the default), float
1810-
PFM files will store scanline 0 as the last scanline in the file (i.e.
1811-
the visual "top" of the image).
1805+
- int
1806+
- If this configuration hint is present and is zero, for PFM files,
1807+
scanline 0 will really be stored first in the file, thus disabling the
1808+
usual automatically flipping that accounts for PFM files conventionally
1809+
being stored in bottom-to-top order. If nonzero (the default), float
1810+
PFM files will store scanline 0 as the last scanline in the file (i.e.
1811+
the visual "top" of the image).
18121812

18131813
**Custom I/O Overrides**
18141814

src/doc/maketx.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Making Tiled MIP-Map Texture Files With `maketx` or `oiiotool`
1212
Overview
1313
========
1414

15-
The TextureSystem (Chapter :ref:`chap-texturesystem_`) will exhibit much
15+
The TextureSystem (Chapter :ref:`chap-texturesystem`) will exhibit much
1616
higher performance if the image files it uses as textures are tiled (versus
1717
scanline) orientation, have multiple subimages at different resolutions
1818
(MIP-mapped), and include a variety of header or metadata fields
@@ -56,7 +56,7 @@ Where *input* and *output* name the input image and desired output filename.
5656
The input files may be of any image format recognized by OpenImageIO (i.e.,
5757
for which ImageInput plugins are available). The file format of the output
5858
image will be inferred from the file extension of the output filename (e.g.,
59-
:filename:`foo.tif` will write a TIFF file).
59+
`foo.tif` will write a TIFF file).
6060

6161
Command-line arguments are:
6262

@@ -511,7 +511,7 @@ Command-line arguments are:
511511
.. sec-oiiotooltex:
512512
513513
`oiiotool`
514-
=========
514+
==========
515515

516516
The :program:`oiiotool` utility (Chapter :ref:`chap-oiiotool`) is capable of
517517
writing textures using the `-otex` option, lat-long environment maps using the
@@ -630,9 +630,9 @@ detailed explanations of each, for the corresponding :program:`maketx`
630630
option):
631631

632632

633-
======================= ============================================
633+
========================= ============================================
634634
Appended Option `maketx` equivalent
635-
======================= ============================================
635+
========================= ============================================
636636
`wrap=` *string* `--wrap`
637637
`swrap=` *string* `--swrap`
638638
`twrap=` *string* `--twrap`
@@ -651,7 +651,7 @@ Appended Option `maketx` equivalent
651651
`uvslopes_scale=` *float* `--uvslopes-scale`
652652
`prman_metadata=1` `--prman`
653653
`prman_options=1` `--prman-metadata`
654-
======================= ============================================
654+
========================= ============================================
655655

656656

657657
Examples

src/doc/oiiointro.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ OpenImageIO incorporates, distributes, or contains derived works of:
230230

231231
* The SHA-1 implementation we use is public domain by Dominik Reichl http://www.dominik-reichl.de/
232232
* PugiXML © 2006-2009 by Arseny Kapoulkine (based on work © 2003 Kristen Wegner), MIT license. http://pugixml.org/
233-
* DPX reader/writer © 2009 Patrick A. Palmer, BSD 3-clause license. https://github.com/patrickpalmer/dpx}
233+
* DPX reader/writer © 2009 Patrick A. Palmer, BSD 3-clause license. https://github.com/patrickpalmer/dpx
234234
* lookup3 code by Bob Jenkins, Public Domain. http://burtleburtle.net/bob/c/lookup3.c
235235
* xxhash © 2014 Yann Collet, BSD 2-clause license. https://github.com/Cyan4973/xxHash
236236
* farmhash © 2014 Google, Inc., MIT license. https://github.com/google/farmhash
@@ -244,8 +244,8 @@ OpenImageIO incorporates, distributes, or contains derived works of:
244244
* fmt library © Victor Zverovich. MIT license. https://github.com/fmtlib/fmt
245245
* UTF-8 decoder © 2008-2009 Bjoern Hoehrmann, MIT license. http://bjoern.hoehrmann.de/utf-8/decoder/dfa
246246
* Base-64 encoder © René Nyffenegger, Zlib license. http://www.adp-gmbh.ch/cpp/common/base64.html
247-
* stb_sprintf © 2017 Sean Barrett, public domain (or MIT license where that may not apply). https://github.com/nothings/stb
248-
* bcdec.h bySergii "iOrange" Kudlai, MIT or Unlicense. https://github.com/iOrange/bcdec
247+
* stb_sprintf © 2017 Sean Barrett, public domain (or MIT license where that may not apply). https://github.com/nothings/stb
248+
* bcdec.h by Sergii "iOrange" Kudlai, MIT or Unlicense. https://github.com/iOrange/bcdec
249249

250250
OpenImageIO Has the following build-time dependencies (using
251251
system installs, referencing as git submodules, or downloading as part of

0 commit comments

Comments
 (0)