summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | | Simplify text about CythonAnderson Bravalheri2022-06-141-23/+21
| | | | |
| * | | | [Docs] Move Cython remarks to the new ext_modules pageAnderson Bravalheri2022-06-143-55/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This helps to consolidate all the information about extensions in a single place and make it easier for users to find the correct guidance.
* | | | | [Docs] Consolidate sdist and MANIFEST.in info into a single document (#3372)Anderson Bravalheri2022-06-142-40/+48
|\ \ \ \ \ | |/ / / / |/| | | |
| * | | | Add remarks and example for MANIFEST.inAnderson Bravalheri2022-06-141-0/+32
| | | | |
| * | | | Consolidate sections about sdist contents in a single documentAnderson Bravalheri2022-06-142-40/+16
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing section about `sdist` in `userguide/distribution` seems to have duplicated content when compared to another section in `userguide/miscellaneous`. We can combine these two sections and simplify the documentation. Changes: - Consolidate text about `sdist` contents and MANIFEST.in into a single place. - De-emphasize ``distutils`` and the history of ``setuptools`` (new users might not know about it, which would make them less confuse).
* | | | [Docs] Move command description to the deprecated practice section (#3371)Anderson Bravalheri2022-06-145-25/+58
|\ \ \ \
| * | | | Add remark about install commandAnderson Bravalheri2022-06-141-2/+15
| | | | |
| * | | | Merge docs on deprecated commandsAnderson Bravalheri2022-06-145-25/+45
| | | | | | | | | | | | | | | | | | | | Also add a not about modern ways of generating ``sdists`` and ``wheel``.
| * | | | Move userguide/commands to deprecated/commandsAnderson Bravalheri2022-06-141-0/+0
| |/ / /
* | | | Improve remark about external dependenciesAnderson Bravalheri2022-06-141-2/+3
| | | |
* | | | Add remarks to docs on extension modulesAnderson Bravalheri2022-06-141-1/+15
| | | |
* | | | Add small exampleAnderson Bravalheri2022-06-141-0/+42
| | | |
* | | | Minor formatting/editorial improvements on ext_modules docsAnderson Bravalheri2022-06-141-30/+40
| | | |
* | | | docs/userguide/ext_modules.rst: More sysconfig variablesMatthias Koeppe2022-06-141-1/+2
| | | |
* | | | docs/userguide/ext_modules.rst: Add more specifics about Extension attributesMatthias Koeppe2022-06-142-1/+10
| | | |
* | | | docs/userguide/ext_modules.rst: NewMatthias Koeppe2022-06-141-0/+40
|/ / /
| | |
| \ \
| \ \
| \ \
*---. \ \ Doc improvements (#3363, #3364, #3367)Anderson Bravalheri2022-06-1315-412/+519
|\ \ \ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Improve docs by avoiding confusion with distutils - Update dependency management docs - Update userguide on miscellaneous and extension
| | | * | | Add note about availability of entry-pointsAnderson Bravalheri2022-06-131-1/+11
| | | | | |
| | | * | | Language adjustmentsAnderson Bravalheri2022-06-131-4/+4
| | | | | |
| | | * | | Remove unused partsAnderson Bravalheri2022-06-132-14/+1
| | | | | |
| | | * | | Apply suggestions from code reviewAnderson Bravalheri2022-06-133-4/+4
| | | | | |
| | | * | | Update userguide on `miscellaneous` and `extension`Anderson Bravalheri2022-06-126-177/+247
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a continuation of the update effort to de-emphasize `distutils` and make the documentation more consistent. The main targets of the changes are the files `docs/userguide/miscellaneous` and `docs/userguide/extension`. Changes: - Extracted text about automatic resource extraction and the zip-safe flag from `userguide/miscellaneous` to `deprecated/resource_extraction` and `deprecated/zip_safe`. - These configuration parameters are commonly associated with ``eggs``/``easy_install``/``pkg_resources``, and therefore are obsolete. Leaving them around in the main parts of the documentation just confuses users. - The text in the new files were updated. - Extracted text about additional metadata from `userguide/miscellaneous` into the existing `userguide/extension` document. - Updated `userguide/extension` to better reflect the status of the setuptools project. The text was also changed to explain a little bit more what is the relationship between ``setuptools`` and ``distutils``. - Removed `userguide/functionalities_rewrite`. This file was virtually empty and not bringing any extra value to the docs.
| | * | | | Apply suggestions from code reviewAnderson Bravalheri2022-06-131-4/+4
| | | | | |
| | * | | | Update dependency management docsAnderson Bravalheri2022-06-124-160/+181
| | |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Extract `depencency_liks` section to a new file: `deprecated/dependency_links.rst` - Add note about directly URLs not being accepted in PyPI. - Simplify intro about build system requirement. - Simplify intro about optional dependencies. - Fix confusion in example about "Project" and "Package". - "Demote" section about extras in entry-points to a note.
| * | | | Apply suggestions from code reviewAnderson Bravalheri2022-06-133-4/+4
| | | | |
| * | | | Improve docs by avoiding confusion with distutilsAnderson Bravalheri2022-06-127-54/+73
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing docs seem to assume that the user is familiar with the history of packaging in the Python ecosystem (or at least know what is `distutils`). Since that is not always the case and that `distutils` is in the process of being adopted by `setuptools`, the documentation should be changed to minimize mentions to `distutils` and avoid expecting too much knowledge from the users. The benefit of this approach is that it can make the docs more accessible and easier to understand. Changes: - Modify landing page to clarify what `setuptools` does (making it more clear to understand for beginners). - Remove mentions to `distutils`, `transition to PEP 517` from `userguide/index`. - Instead the text is changed to have a more "introductory" tone. - Remove mentions to `distutils` from the Quickstart. - Remove `python2` from the intersphinx mapping - it was causing trouble redirecting glossary terms to Python2 docs, instead of Python3. - Modify documentation about development mode to be more aligned with current practices (i.e. using `pip install -e .`) - In this process all documentation about running `setuptools` commands in `distutils` projects was moved to a new file in `docs/deprecated/running_commands.rst`
* | | | Merge https://github.com/jaraco/skeletonJason R. Coombs2022-06-121-12/+12
|\ \ \ \
| * | | | Update base URL for PEPs (#61)Hugo van Kemenade2022-06-041-1/+1
| | | | |
* | | | | Fix up subsections of the "Entry Points for Plugins" sectionSaniya Maheshwari2022-06-121-15/+10
| | | | | | | | | | | | | | | | | | | | | | | | | - Convert the `importlib.metadata` subsection into a Tip. - Remove the 'Summary' subsection header.
* | | | | Apply suggestions from code reviewSaniya Maheshwari2022-06-121-3/+4
| | | | | | | | | | | | | | | Co-authored-by: Anderson Bravalheri <andersonbravalheri+github@gmail.com>
* | | | | Added a single space around the `=` sign in `setup.py` snippetsSaniya Maheshwari2022-06-121-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Have checked that the snippets continue to work with this space included. The space improves readability, hence this is probably a good addition.
* | | | | Fixed up indentation issueSaniya Maheshwari2022-06-121-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | Some extra indentation was causing the code block to be interpreted as a code block within a blockquote.
* | | | | Added a few lines to make the purpose of the syntax clearSaniya Maheshwari2022-06-121-1/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A few lines have been added in each of the sections on Console Scripts, GUI scripts and Entry Points for Plugins. A line has also been added at the end of the Syntax section to further make things clear.
* | | | | Section on Entry Points SyntaxSaniya Maheshwari2022-06-121-10/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Matter is courtesy of @abravalheri. Have removed the `.ini` syntax highlighting of the code blocks so that the syntax does not appear specific to `setup.cfg` but more general-purpose. Have also moved this section down to the end of the document so that users can refer to it after having a basic understanding of how each of console scripts, GUI scripts, and entry points work.
* | | | | Removed Dependency Management section of the Entry Points pageSaniya Maheshwari2022-06-111-23/+0
| | | | | | | | | | | | | | | | | | | | | | | | | Since it is deprecated and relevant details have already been covered in a separate Dependencies Management page.
* | | | | Added note in `pyproject.toml` snippet for plugin exampleSaniya Maheshwari2022-06-111-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | Explains why quoting around `timmins.display` is required. Might be helpful for beginners.
* | | | | Changed indentation in `setup.cfg` snippetsSaniya Maheshwari2022-06-111-9/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Indentation was 8 spaces. Should be 4 spaces for consistency with other `setup.cfg` snippets. Also fixed up tab/spaces glitches in other places.
* | | | | Better opening statement for the Entry Points pageSaniya Maheshwari2022-06-111-4/+15
| | | | |
* | | | | Plugin name is `timmins-plugin-fancy`Saniya Maheshwari2022-06-111-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | Had incorrectly used `timmins_plugin_fancy` instead of `timmins-plugin-fancy` in several places.
* | | | | Corrected syntax in `setup.py`Saniya Maheshwari2022-06-111-2/+2
| |/ / / |/| | | | | | | | | | | | | | | Had used `=` for separating key and value pair in dictionary, should have `:` instead.
* | | | Changes to the User Guide's Entry Points page (#3355)Anderson Bravalheri2022-06-111-56/+399
|\ \ \ \
| * | | | Apply suggestions from code reviewAnderson Bravalheri2022-06-111-2/+2
| | | | |
| * | | | Changed the last paragraph of the old example into a summary statementSaniya Maheshwari2022-06-111-3/+8
| | | | |
| * | | | Removed example in old documentationSaniya Maheshwari2022-06-111-30/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Old example was on loading entry points corresponding to console scripts. - Everything in that example has probably been included in the newer example.
| * | | | Illustrate different ways of implementing/loading EPsSaniya Maheshwari2022-06-111-0/+73
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Defining multiple EPs under the same group - Loading an EP by its name - Loading all EPs in a given group
| * | | | This statement is not requiredSaniya Maheshwari2022-06-111-2/+0
| | | | |
| * | | | Replace 'console script' with 'console/GUI script'Saniya Maheshwari2022-06-111-2/+2
| | | | | | | | | | | | | | | | | | | | In the Advertising Behaviour section.
| * | | | Subsection on `importlib.metadata` and its backportSaniya Maheshwari2022-06-111-3/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Indicated that for Python versions lower than 3.8, the backport should be used. - Indicated that the only change that needs to be made while using the backport, is to replace `importlib.metadata` with `importlib_metadata`.
| * | | | Added a note on what `display_eps` would look likeSaniya Maheshwari2022-06-101-4/+15
| | | | | | | | | | | | | | | | | | | | Snippet borrowed from Python Packaging user guide
| * | | | Added a lengthy example on entry points and pluginsSaniya Maheshwari2022-06-101-3/+165
| | | | |
View Lorry Controller Status