summaryrefslogtreecommitdiff
Commit message (Collapse)AuthorAgeFilesLines
...
* MAINT: Fix CircleCI (#336)Eric Larson2021-10-221-1/+2
|
* Update install.rst (#332)Dmitriy Fishman2021-09-271-1/+1
|
* MAINT: Python3 classes do not need to inherit from object (#325)Mike Taves2021-05-192-2/+2
|
* FIX: Fix RTDEric Larson2021-04-212-0/+3
|
* DOC: Add headers to docstring sections to add link anchors (#320)Ross Barnowski2021-04-191-306/+338
| | | | | | | * DOC: replace enumerated list with headings. Creates anchor links for individual docstring sections. * Add internal links to newly anchored section headings.
* Be explicit about leading * when documenting *args, **kwargs. (#310)Matthias Bussonnier2021-04-191-0/+12
| | | | | | | | | | | This seem to be what most docstring involving args/kwargs are doing including the example.py; Though I've seen other project be less consistant, so make the suggestion explicit instead of letting users infer from the example. Other convention I've seen are: - `*xi` , documented as `x1,x2, ..., xn : type` - just the name without the leading `*`/`**`. - prefixing `*` with `\\*`.
* Merge pull request #319 from larsoner/circleRalf Gommers2021-04-192-3/+9
|\ | | | | MAINT: Update Circle and conf.py
| * FIX: Missing linksEric Larson2021-04-181-1/+1
| |
| * BUG: Fix navbar search posEric Larson2021-04-181-1/+1
| |
| * MAINT: Make tinybuildEric Larson2021-04-181-2/+8
|/
* MAINT: changes related to renaming default branch (#314)Ross Barnowski2021-04-135-9/+6
| | | | | | | | | | | * Update CI config. * Rm travis badge from readme. * Fix link to GH. * Rm master_doc - default is index anyways. * Add back master_doc w/ note.
* MAINT: use super() as described by PEP 3135 (#315)Mike Taves2021-03-223-3/+3
|
* DOC: Switch docs to pydata-sphinx-theme (#313)masterRoss Barnowski2021-02-2611-60/+35
| | | | | | | | | | | | | | | | | | | | | * Rm scipy-sphinx-theme submodule. * Add pydata-sphinx-theme to doc reqs. * Modify conf to use pydata theme. * Add github badge via theme. * Update CI. * bump CI sphinx version 1.6.5 -> 1.8 for tests * Experimental: swap sidebars in theme. * Add :notoc: to index to suppress right sidebar. * FIX: No sidebar Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* DOC: Add section about validation via sphinx-build. (#312)Ross Barnowski2021-02-241-0/+29
| | | | | Adds a section to the documentation on validation describing how numpydoc can be configured to run docstring validation during the sphinx-build process.
* ENH: Enable validation during sphinx-build process (#302)Ross Barnowski2021-02-0811-53/+299
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * WIP: Move get_doc_obj to docscrape * WIP: mv _obj property to NumpyDocString * Proof-of-concept: Docstring attrs covered by refactor. Running the test suite on this patch demonstrates that refactoring the boundary between NumpyDocString and SphinxDocString provides the necessary info to (potentially) do away with the validate.Docstring class. * NOTE TO SELF: get_doc_object in docscrape_sphinx * Docstring -> Validator. * Activate validation during sphinx-build. Add a conf option to turn on/off. TODO: test * Replace logger.warn with warning. logger.warn is apparently deprecated * DOC: Add numpydoc_validate to conf docs. * Add mechanism for validation check selection. Adds a config option with a set to allow users to select which validation checks are used. Default is an empty set, which means none of the validation checks raise warnings during the build process. Add documentation for new option and activate in the doc build. * TST: modify how MockApp sets builder app. * TST: Add test of validation warnings. * Specify some sensible validation defaults. * Add docstring name to validation warnings. * Add all keyword to validation_check configuration. More flexibility in configuring which validation checks to run during sphinx build. If 'all' is present, treat the rest of the set as a blocklist, else an allowlist. * Fix failing test. * Make validation error mapping easier to read. * Add check for invalid error codes in configuration. plus test. * Add feature to exclude patterns from docstring validation. Modify updated config name to avoid sphinx warning. Add documentation for exclusion config value. * Be explicit about regex syntax for exclude config val Co-authored-by: Eric Larson <larson.eric.d@gmail.com> * Rm redundant numpydoc_validate config param. Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* DOC: fix erroneous numpydoc_edit_link formatting (#309)Stefan Appelhoff2021-01-211-20/+22
| | | | | | | | | * fix format: add linebreak * consistent indent * add deprecation version arg to numpydoc_edit_link * add blank line after directive
* document default values as part of the type spec (#289)keewis2021-01-091-0/+7
|
* Merge pull request #308 from rgommers/fix-missing-objRalf Gommers2021-01-021-1/+1
|\ | | | | BUG: fix an incomplete check in `Reader._error_location`
| * BUG: fix an incomplete check in `Reader._error_location`Ralf Gommers2021-01-011-1/+1
|/ | | | | | | It's unclear why `self._obj` can be None, but that's what I'm seeing when trying numpydoc master to build SciPy master. This fix gives the right traceback.
* Merge pull request #295 from rossbar/xref_confRalf Gommers2021-01-014-10/+144
|\ | | | | ENH: Add configuration option for parameter cross-referencing
| * ALTERNATIVE: overload xref_ignore config valueRoss Barnowski2020-08-216-36/+37
| |
| * DOC: fix indentation errorRoss Barnowski2020-08-171-2/+3
| |
| * DOC: document config value/kwargRoss Barnowski2020-08-172-0/+20
| |
| * Add config value to control behaviorRoss Barnowski2020-08-173-2/+10
| |
| * WIP: kwarg to ignore unknown terms in make_xref.Ross Barnowski2020-08-172-3/+107
| | | | | | | | | | Add a kwarg to make_xref to toggle the automatic wrapping of every term not in xref_ignore in an :obj: role.
* | Merge pull request #272 from rossbar/maint/rm_codepathRalf Gommers2021-01-011-4/+0
|\ \ | | | | | | MAINT: remove unreachable codepath.
| * | MAINT: remove un-reachable codepath.Ross Barnowski2020-06-301-4/+0
| | | | | | | | | | | | Removes conditional after a return statement.
* | | CI: Switch from travis to Github actions for tests (#307)Ross Barnowski2020-12-153-54/+65
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Setup test workflow with github actions * Add sphinx version to matrix. * Add doc building to test workflow. * Add codecov step to test workflow. * Remove travis config. * WIP: try without action.
* | | Improve error messages for see also parsing (#306)Ross Barnowski2020-12-094-32/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | * More informative error message for see also parse error. * Improve _error_location method output. * TST: Update test suite. * CI: Update sphinx==1.6.5 job from Python 3.5 to 3.6
* | | Merge pull request #300 from WarrenWeckesser/long-see-also-entryRalf Gommers2020-10-311-0/+10
|\ \ \ | | | | | | | | Add a note to the docstring standard about long 'See Also' entries.
| * | | Add a note to the docstring standard about long 'See Also' entries.Warren Weckesser2020-10-311-0/+10
|/ / /
* | | Fix missing periods (#298)Albert Villanova del Moral2020-09-032-8/+8
| | |
* | | MAINT: minor refactoring in docscrape (#297)Ross Barnowski2020-08-191-24/+5
| | | | | | | | | | | | | | | | | | | | | * MAINT: rm unnecessary elses in _str methods * rm unused indent method from NDS * rm unused header method from NDS
* | | MAINT: pytest ignore doc directory. (#296)Ross Barnowski2020-08-181-1/+1
| | | | | | | | | | | | Update pytest config to ignore entire doc/ directory. This prevents an import name collision in doc/scipy-sphinx-theme/conf.py.
* | | DOC: fix inaccuracy in validate docstring. (#294)Joel Nothman2020-08-181-4/+7
|\ \ \ | |_|/ |/| |
| * | Missed argument renameRoss Barnowski2020-08-171-1/+1
| | |
| * | DOC: fix inaccuracy in validate docstring.Ross Barnowski2020-08-121-3/+6
|/ /
* | Fix param parsing. (#286)Matthias Bussonnier2020-08-102-14/+36
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix param parsing. Closes #285 This fixes two tings: - When first sentence of the docstring is onteh first line, Parameters is not properly parse, which for example mis parsed numpy.array docstring. - many project have paremeters description list with ` :` afer the name, even if no type is present. If there is no space after the `:` the parameter name includes the ` :` which is most likely wrong. * test fixture * make doc a fixture * Update numpydoc/tests/test_docscrape.py Co-authored-by: Eric Larson <larson.eric.d@gmail.com> * Update numpydoc/tests/test_docscrape.py Co-authored-by: Eric Larson <larson.eric.d@gmail.com> Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* | MAINT: Updates related to xref (#292)Ross Barnowski2020-08-053-48/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | * TST: use default links in xref test. Switch to numpydoc's default link mapping for test_xref instead of the custom (less comprehensive) link mapping. * DOC: rm statements about xref_alias dict. Default aliases are not an empty dict, nor are they dependent on intersphinx. * DOC: Update make_xref docstring.
* | BUG: Properly parse See Also when summary on first line. (#283)Matthias Bussonnier2020-07-162-4/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | in a case like: """signature See Also -------- a,b,c,d """" Numpydoc would incorrectly assign `a, b, c, d` as a description with no name, or type associated items. Closes #281
* | fix spliting of parameter lines. (#279)Matthias Bussonnier2020-07-142-3/+21
| | | | | | | | if ' : ' is present twice in the line this drops any test after the second ' : ', which happens in some docstring that have the `default : stuff` idiom
* | ENH: Better warning for sections. (#278)Matthias Bussonnier2020-07-142-2/+36
| | | | | | | | | | | | | | | | | | | | | | * ENH: Better warning for sections. 1) if the number of -/= is too short/ too long warn, Especially too short it won't be detected as a section. 2) for duplicate section print the docstring to figure out where the problem is. * add warn test
* | BUG: fix role regex.Matthias Bussonnier2020-07-132-1/+6
| | | | | | | | | | Spyder sometime uses the full :py:meth: role, this make sure it is properly handled.
* | MAINT: Tick versionEric Larson2020-07-011-1/+1
| |
* | MAINT: Remove dev, update notesv1.1.0Eric Larson2020-07-012-20/+32
|/
* MAINT: Refactor test_xref to use parametrization.Ross Barnowski2020-06-301-9/+7
| | | | | Each pair of input/output in data is treated as an individual test, aiding in detection of specific failures.
* MAINT: Py3k rm explicit inherit from object.Ross Barnowski2020-06-302-7/+7
|
* MAINT: Fix code comments.Ross Barnowski2020-06-301-2/+3
| | | | | | | | A comment pertaining to docutils_namespace() had been separated from the code that it was referring to. Moved comment back to appropriate location and added a separate comment to unrelated code to differentiate the two.
* MAINT: Refactor - parametrize test_referenceRoss Barnowski2020-06-301-17/+12
| | | | | | Refactors test_full.test_reference using the parametrization facilities of pytest. In principle, improves readibility and makes it easier to extend the test.
* MAINT: Update test docstring.Ross Barnowski2020-06-301-1/+1
| | | | | Description appears to have been ported directly over from sphinx-gallery example. Updated to match current test function.
View Lorry Controller Status