Commit Graph
9 Commits
Author SHA1 Message Date
Antony Lee 386ec9cd9a Fix doc typo. 2019-03-07 14:17:41 +01:00
Antony Lee dbb7c38220 Rendering of exceptions by napoleon. (#4046)
This lets napoleon render exceptions using the standard info field
syntax
```
:raises FooException: Some condition.
```
rather than the nonstandard
```
:raises: :exc:`FooException` -- Some condition.
```

Note that the previous approach was more forgiving if an explanatory
text was given in the Raises section without an actual exception class:
```
Raises
------
If something occurs.
```
would be rendered as
```
:raises: *If something occurs*
```
which is OK-ish but is now rendered as
```
:raises If something occurs.:
```
which is somewhat more nonsensical.

However neither the Google style guide nor numpydoc actually support
this form (they always have both the type and the description) so I
think the change is reasonable.
2018-09-23 08:31:27 -04:00
Antony Lee 732ebb5d1e Capitalization: "Table Of Contents" -> "Table of Contents".
This is consistent with "Complete Table of Contents" (which is already
in the database), as well as e.g. "Indices and Tables" where "and" is
not capitalized.

This is also fairly standard title-case practice.
2018-07-22 12:12:48 +02:00
Antony Lee f101bb6615 Remove unused SPHINXPROJ from new Makefile/make.bat. 2018-05-10 13:23:59 -07:00
Antony Lee 6e6a573cba Fix typo in output of sphinx-build -h. 2017-09-17 22:48:14 +09:00
Antony Lee ddd23d31f1 Fix typo in output of sphinx-build -h. 2017-09-08 22:56:39 -07:00
Antony Lee cfa03b9771 Fix documented default values for setuptools integration.
The defaults were obtained by reading the implementation in
`setup_command.py`, notably `_guess_source_dir` and `finalize_options`.
2017-09-01 22:30:04 -07:00
Antony Lee 65aa87c6e9 Clarify error message when any role has more than one target.
(by including the full names of the candidate targets)
2017-08-23 14:56:15 -07:00
Antony Lee 0832aa73ab Default SPHINXBUILD to 'python -msphinx' instead of 'sphinx-build'.
Using `python -msphinx` as the default for SPHINXBUILD in the
Makefile/make.bat ensures that whatever virtual environment is currently
active (if any) gets picked up.  In the current situation, imaging that
we are working on project $foo which is also installed system-wide,
but we want to build docs for a venv-installed version; that sphinx
is installed system-wide but not in the current environment, and that
e.g. conf.py imports $foo (e.g. to retrieve a version string).  Then
sphinx-build will resolve to the globally installed version, and the
global (wrong) version of $foo will be imported as well.

With this fix, `make html` will do everything in the correct virtualenv
(if any).  This switch is similar in spirit to e.g. the deprecation of
the `pyvenv` script in Py3.6, in favor of `python -mvenv`.
2017-03-06 18:16:27 -08:00