summaryrefslogtreecommitdiff
path: root/docs/userguide
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'master' into feature/2093-docs-revampfeature/2093-docs-revampJason R. Coombs2020-09-231-6/+6
|
* Merge commit '52c394c' into feature/2093-docs-revampJason R. Coombs2020-09-231-2/+2
|
* Merge commit 'd6bcf5e' into feature/2093-docs-revampJason R. Coombs2020-09-231-2/+8
|
* Merge pull request #2157 from alvyjudy/dependencyJason R. Coombs2020-08-151-129/+186
|\ | | | | step 7 on 2093: dependency management guide ready
| * docs: rephrased the introduction for optional dependenciesalvy2020-07-291-5/+9
| | | | | | note the use case for tests and docs functions and that "test_require" is deprecated, shorten description of the example
| * docs: remove note on "require" functionalityalvy2020-07-291-6/+0
| |
| * docs: remove mentioning of multiversion installalvy2020-07-291-3/+1
| |
| * docs: give python requirement a dedicated sectionalvy2020-07-291-8/+9
| |
| * docs: reference PEP440 for versions specifiersalvy2020-07-291-2/+3
| |
| * docs: remove editorial message and lengthy description of dependency typealvy2020-07-291-4/+2
| |
| * docs: restored notes on "require()" functionalvyjudy2020-05-281-0/+6
| |
| * docs: more finetuning on dependency guidealvyjudy2020-05-281-60/+68
| |
| * docs: editing user guide on dependency managementalvyjudy2020-05-281-90/+137
| |
* | Correct some of the behaviors indicated in new entry points docs. Switch to ↵Jason R. Coombs2020-06-151-140/+94
| | | | | | | | imperative voice. Limit to declarative config (setup.cfg) examples.
* | docs: fixed mistaken explanationalvyjudy2020-05-281-2/+2
| |
* | docs: guide on entry point completedalvyjudy2020-05-281-63/+118
| | | | | | | | | | | | | | Coverage 1. console_script 2. plugin support 3. optional dependencies
* | docs: update entry point userguidealvyjudy2020-05-281-13/+19
| |
* | docs: detail userguide for entry point WIPalvyjudy2020-05-281-47/+71
|/
* Mention that `namespace_packages` is omitted.Jason R. Coombs2020-05-271-1/+2
|
* docs: cover pkgutil style namespace pkgalvyjudy2020-05-261-8/+33
|
* docs: detail pkg discover guide and namespace pkgalvyjudy2020-05-261-105/+105
| | | | | | userguide/pkg_discovery.txt now covers find_package, find_namespace package and legacy use of namespace package creation in both setup.py and setup.cfg style
* docs: WIP detailed guide on pkg discoveryalvyjudy2020-05-261-38/+63
|
* docs: add dev mode section in quickstartalvyjudy2020-05-251-0/+20
|
* docs: proper invocation of pep517alvyjudy2020-05-251-1/+1
| | | | | before: pep517 build (incorrect) now: python -m pep517.build (correct)
* docs: update quickstartalvyjudy2020-05-251-12/+32
| | | | added a few sections (WIP) to make it more complete
* docs: update quickstartalvyjudy2020-05-251-47/+12
| | | | | | | | | | | | | | It is now declarative and covers the following aspects of packaging: - installation - basic use - package discovery - entry points - dependencies - data files Each section comprises a brief demonstration of the functionality and provide a link to more advanced explanation
* docs: changed some mistaken explanation in quickstalvyjudy2020-05-251-53/+44
|
* docs: made quickstart pkg section declarativealvyjudy2020-05-201-12/+17
| | | | WIP
* docs: WIP update quickstart guidealvyjudy2020-05-181-56/+53
| | | | to make it pep517-compatible and declarative
* docs: dedicate a file for miscel functionalitiesalvyjudy2020-05-141-1297/+0
| | | | | these should be properly grouped but for now I'm just leaving them here
* docs: dedicate a file for extending setuptoolsalvyjudy2020-05-141-0/+235
|
* docs: dedicate a file for distribution guidealvyjudy2020-05-141-0/+240
|
* docs: dedicate a file for datafiles supportalvyjudy2020-05-141-0/+174
|
* docs: update index to match filenamealvyjudy2020-05-141-1/+1
|
* docs: dedicate a file for development modealvyjudy2020-05-141-0/+60
|
* docs: udpate quickstart to match ref filealvyjudy2020-05-141-3/+1
|
* docs: dedicate a file for dependency managementalvyjudy2020-05-141-0/+255
|
* docs: update userguide index to match filenamealvyjudy2020-05-141-2/+2
|
* docs: dedicate a file for entry pointsalvyjudy2020-05-141-0/+115
|
* docs: udpate package_discovery.txtalvyjudy2020-05-141-5/+17
|
* docs: dedicate file for package discoveryalvyjudy2020-05-141-0/+169
|
* docs: udpate title of quickstartalvyjudy2020-05-141-4/+8
|
* docs: update userguide indexalvyjudy2020-05-141-5/+11
|
* docs: merge function walkthrough into quickstartalvyjudy2020-05-142-131/+131
|
* docs: put the remaining functionalities into miscealvyjudy2020-05-141-0/+0
| | | | | those that don't need to put into a dedicated file are now inside the miscellaneous.txt
* docs: update functionalities.txtalvyjudy2020-05-141-32/+29
| | | | outline is completed, now to fill the donut holes
* docs: WIP rewrite functionalitiesalvyjudy2020-05-141-0/+143
| | | | | | such that each section is comprised of a quick intro and example that illustrate the use of that functionality and provide a link to a more detailed explanation.
* docs: migrated sectionalvyjudy2020-05-131-32/+0
| | | | egg-secutable section moved from userguide/functionalities to deprecated/functionalities
* docs: removed unnecessary transition paragraphalvyjudy2020-05-131-3/+1
| | | | so that the quickstart is cleaner for now. Might add more text later
* docs: migrated section for versioningalvyjudy2020-05-132-85/+86
| | | | from quickstart.txt to functionalities.txt
View Lorry Controller Status