summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
| | * Revert "Fix regex compilation in example for Python 2.7"Seth Morton2019-11-081-1/+1
| | | | | | | | | | | | This reverts commit c0683515c3195c6a483c7e8b976600a7d42ed70b.
| | * Fix regex compilation in example for Python 2.7Seth Morton2019-11-081-1/+1
| | |
| | * Fix egregious error in exampleSeth Morton2019-11-071-1/+1
| | |
| | * Add sorting example to documentationSeth Morton2019-11-071-0/+50
| | |
| | * Expose numeric_regex_chooser as publicSeth Morton2019-11-071-1/+8
| | |
| * | Fix typo "the the"Jon Dufresne2019-06-201-3/+3
| |/
* | Merge pull request #98 from hugovk/drop-python2-support-upgrade-syntaxdrop-python2-supportSeth Morton2019-08-171-8/+8
|\ \ | | | | | | Upgrade Python syntax with pyupgrade --py3-plus
| * | Upgrade Python syntax with pyupgrade --py3-plusHugo2019-08-171-8/+8
| |/
* | Update version requirementsHugo2019-08-171-2/+2
| |
* | Remove Python 2-only feature from docsHugo2019-08-171-25/+0
|/
* Move docs dependencies into docs/requirements.txtSeth Morton2019-03-031-0/+1
| | | | This is to enable new markdown source files on readthedocs
* Move development collateral into a dev/ folderSeth Morton2019-03-031-2/+2
| | | | | | | | | This keeps the root directory cleaner. Dependent files and documentation has been modified to relfect the change. Additionally, the bump.sh file has been updated to force the use of bump2version over bumpversion, and to use a cross-platform sed invokation.
* Incorporate new CHANGELOG.md into sphinx documentationSeth Morton2019-03-022-3/+4
| | | | This requires the use of the m2r sphinx extension
* Bump version: 5.5.0 → 6.0.06.0.0Seth Morton2019-02-041-1/+1
|
* Update information about deprecationSeth Morton2019-02-041-19/+19
|
* Rename "test_natsort" directory to "tests"Seth M Morton2018-11-181-1/+1
| | | | I think it's clear that the unit tests will be testing natsort...
* Update documentation to not mention pipenvSeth M Morton2018-11-181-7/+6
|
* Revert "Revert "Drop support for EOL Pythons""Seth M Morton2018-11-183-7/+3
| | | | This reverts commit 916a92d39eaf5ef282b421c4772a7ec831750c4c.
* Bump version: 5.4.1 → 5.5.05.5.0Seth M Morton2018-11-181-1/+1
|
* Merge pull request #85 from SethMMorton/make-a-better-changelogSeth Morton2018-11-181-371/+1
|\ | | | | Make a better changelog
| * Move the changelog to the top-level directorySeth M Morton2018-11-181-371/+1
| | | | | | | | The changelog in the docs now just includes the top-level changelog.
* | Add note about Pipenv being dropped from build infrastructureSeth M Morton2018-11-181-0/+6
| |
* | Update "how-to-test" and add "how-to-build-docs"Seth M Morton2018-11-181-1/+19
|/
* Fix header sizes in READMESeth M Morton2018-11-181-2/+5
| | | | Accidentally I made a subsection's headers bigger than it's parents.
* Remove dropping of Py 2.6 and 3.3 from changelogSeth M Morton2018-11-181-1/+1
| | | | Replaced it with a deprecation note.
* Change recommendation about how to detect DeprecationWarningsformal-deprecation-noticesSeth M Morton2018-11-171-3/+4
| | | | | | If you turn DeprecationWarnings into errors, code can stop just due to python startup DeprectionWarnings - you'll never even get to your code! It's much better just to allow DeprecationWarnings to bubble up.
* Add a deprecation schedule to READMESeth M Morton2018-11-171-0/+44
| | | | | This deprecation schedule calls out what will be changing and in what versions.
* Revert "Drop support for EOL Pythons"Seth M Morton2018-11-173-3/+7
| | | | This reverts commit 36cd8f38e1f1725dfc0078b6f42e35855372bb93.
* Update documentation about version sortingSeth M Morton2018-11-142-10/+34
| | | | | | | The documentation used to give the impression that natsort comprehended versions in a meaningful way. Hopefully that fantasy has been dispelled. This is in response to the discussion in #61.
* Add documentation consolidation line item to changelogSeth M Morton2018-11-101-0/+1
|
* Consolidate API into a single pageSeth M Morton2018-11-1016-136/+90
| | | | | | | | | | Rather than users click through individual functions, it is now all on a single page. Additionally, a bug where the ns enum had no data in the documentation has been fixed. The `versorted` and `index_versorted` functions have been omitted.
* Merge branch 'master' of github.com:SethMMorton/natsortSeth M Morton2018-11-103-27/+23
|\
| * Merge pull request #79 from jdufresne/intersphinxSeth Morton2018-11-103-27/+23
| |\
| | * Use intershpinx to build links to Python docsJon Dufresne2018-11-103-27/+23
| | | | | | | | | | | | | | | Automatically builds the correct URL so they do not need to be manually maintained.
* | | Update changelogSeth M Morton2018-11-101-121/+127
|/ / | | | | | | | | | | - Add the changes for the upcoming release - Add "thanks" to previous pull request submitters - Remove period on all bullet-points
* | Drop support for EOL PythonsJon Dufresne2018-11-103-7/+3
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Support matrix now matches the test matrix from 6233f07bf303d442b39ac677fa6079acc64834a6. By matching these, helps to ensure all supported Python do indeed work. Python 2.6 and 3.3 are end of life. They are no longer receiving bug fixes, including for security issues. Python 2.6 went EOL on 2013-10-29 and on 2017-09-29. For additional details on support Python versions, see: Supported: https://devguide.python.org/#status-of-python-branches EOL: https://devguide.python.org/devcycle/#end-of-life-branches Removing support for EOL Pythons will reduce testing and maintenance resources while allowing the library to move towards a modern Python 3 style. Using pypinfo, we can show the PyPI download statistics, show very low numbers for EOL Pythons. | python_version | percent | download_count | | -------------- | ------: | -------------: | | 2.7 | 48.94% | 37,036 | | 3.6 | 26.58% | 20,113 | | 3.5 | 15.38% | 11,642 | | 3.4 | 5.93% | 4,488 | | 3.7 | 3.13% | 2,365 | | 3.3 | 0.03% | 21 | | 2.6 | 0.01% | 9 | | Total | | 75,674 |
* Flatten docs/ directory structureJon Dufresne2018-11-1024-0/+0
| | | | | Remove unnecessary intermediate directory "source/". Helps make the structures a bit flatter and easier to navigate.
* Merge pull request #77 from jdufresne/pyicu-linkSeth Morton2018-11-101-12/+13
|\ | | | | Consolidate duplicate link names in docs/source/locale_issues.rst
| * Consolidate duplicate link names in docs/source/locale_issues.rstJon Dufresne2018-11-101-12/+13
| | | | | | | | | | | | | | | | | | Fixes Sphinx warning of the form: natsort/docs/source/locale_issues.rst:7: WARNING: Duplicate explicit target name: "pyicu". natsort/docs/source/locale_issues.rst:7: WARNING: Duplicate explicit target name: "pyicu". natsort/docs/source/locale_issues.rst:7: WARNING: Duplicate explicit target name: "pyicu". natsort/docs/source/locale_issues.rst:7: WARNING: Duplicate explicit target name: "pyicu".
* | Merge pull request #75 from jdufresne/doc-linksSeth Morton2018-11-101-7/+5
|\ \ | | | | | | Use native Sphinx ref linking to create automatic links in docs
| * | Use native Sphinx ref linking to create automatic links in docsJon Dufresne2018-11-101-7/+5
| |/
* | Correct highlighting language in docsJon Dufresne2018-11-105-82/+100
|/ | | | | | | | | | | | | | | | | | | | | - Use pycon for Python console. - Use console for Bash console. - Use none for --help output Fixes Sphinx warning of the form: natsort/docs/source/howitworks.rst:176: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/howitworks.rst:231: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/howitworks.rst:249: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/shell.rst:79: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/shell.rst:88: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/shell.rst:98: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/shell.rst:102: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/shell.rst:113: WARNING: Could not lex literal_block as "python". Highlighting skipped. natsort/docs/source/shell.rst:129: WARNING: Could not lex literal_block as "python". Highlighting skipped. For a full list of supported lexers, see: http://pygments.org/docs/lexers/
* Trim trailing white space throughout the projectJon Dufresne2018-11-0719-22/+6
| | | | | | Many editors clean up trailing white space on save. By removing it all in one go, it helps keep future diffs cleaner by avoiding spurious white space changes on unrelated lines.
* Merge pull request #74 from jdufresne/pypiSeth Morton2018-11-062-2/+2
|\ | | | | Update all pypi.python.org URLs to pypi.org
| * Update all pypi.python.org URLs to pypi.orgJon Dufresne2018-11-062-2/+2
| | | | | | | | | | | | For details on the new PyPI, see the blog post: https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
* | Update URLs to use https:// where availableJon Dufresne2018-11-064-22/+22
|/
* Bump version: 5.4.0 → 5.4.15.4.1Seth M Morton2018-09-092-2/+2
|
* Add changelog.Seth M Morton2018-09-091-0/+6
|
* Bump version: 5.3.3 → 5.4.05.4.0Seth M Morton2018-09-062-2/+2
|
* Update changelog.Seth M Morton2018-09-061-0/+1
|