Browse Source

Updated the documentation

tags/v9.0.0
Cédric Belin 2 months ago
parent
commit
2b04d9ff76
11 changed files with 96 additions and 64 deletions
  1. +5
    -5
      README.md
  2. +1
    -6
      RoboFile.php
  3. +3
    -3
      composer.json
  4. +20
    -0
      doc/about/license.md
  5. +4
    -4
      doc/about/see_also.md
  6. +0
    -44
      doc/mkdocs.yaml
  7. +3
    -1
      doc/usage/api.md
  8. +3
    -1
      doc/usage/cli.md
  9. +50
    -0
      etc/mkdocs.yaml
  10. +1
    -0
      etc/requirements.txt
  11. +6
    -0
      readthedocs.yaml

+ 5
- 5
README.md View File

@@ -4,13 +4,13 @@
Find the instances of an executable in the system path, in [PHP](https://www.php.net).

## Documentation
- [User guide](https://dev.belin.io/which.php)
- [API reference](https://dev.belin.io/which.php/api)
- [User guide](https://docs.belin.io/which.php)
- [API reference](https://api.belin.io/which.php)

## Development
- [Git repository](https://github.com/cedx/which.php)
- [Git repository](https://git.belin.io/cedx/which.php)
- [Packagist package](https://packagist.org/packages/cedx/which)
- [Submit an issue](https://github.com/cedx/which.php/issues)
- [Submit an issue](https://git.belin.io/cedx/which.php/issues)

## License
[Which for PHP](https://dev.belin.io/which.php) is distributed under the MIT License.
[Which for PHP](https://docs.belin.io/which.php) is distributed under the MIT License.

+ 1
- 6
RoboFile.php View File

@@ -62,13 +62,8 @@ class RoboFile extends Tasks {
function doc(): Result {
$phpdoc = PHP_OS_FAMILY == 'Windows' ? 'php '.escapeshellarg('C:\Program Files\PHP\share\phpDocumentor.phar') : 'phpdoc';
return $this->collectionBuilder()
->addTask($this->taskFilesystemStack()
->copy('CHANGELOG.md', 'doc/about/changelog.md')
->copy('LICENSE.md', 'doc/about/license.md'))
->addTask($this->taskExec("$phpdoc --config=etc/phpdoc.xml"))
->addTask($this->taskExec('mkdocs build --config-file=doc/mkdocs.yaml'))
->addTask($this->taskFilesystemStack()
->remove(['doc/about/changelog.md', 'doc/about/license.md', 'www/mkdocs.yaml']))
->addTask($this->taskExec('mkdocs build --config-file=etc/mkdocs.yaml'))
->run();
}



+ 3
- 3
composer.json View File

@@ -1,6 +1,6 @@
{
"description": "Find the instances of an executable in the system path. Like the `which` Linux command.",
"homepage": "https://dev.belin.io/which.php",
"homepage": "https://docs.belin.io/which.php",
"license": "MIT",
"name": "cedx/which",
"type": "library",
@@ -45,7 +45,7 @@
"test": "robo test"
},
"support": {
"docs": "https://dev.belin.io/which.php/api",
"issues": "https://github.com/cedx/which.php/issues"
"docs": "https://api.belin.io/which.php",
"issues": "https://git.belin.io/cedx/which.php/issues"
}
}

+ 20
- 0
doc/about/license.md View File

@@ -0,0 +1,20 @@
# MIT License
Copyright © 2017 - 2020 Cédric Belin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 4
- 4
doc/about/see_also.md View File

@@ -1,14 +1,14 @@
# See also

## Development
- [API reference](https://dev.belin.io/which.php/api)
- [API reference](https://api.belin.io/which.php)
- [Packagist package](https://packagist.org/packages/cedx/which)
- [Submit an issue](https://github.com/cedx/which.php/issues)
- [Submit an issue](https://git.belin.io/cedx/which.php/issues)

## Testing
- [Continuous integration](https://github.com/cedx/which.php/actions)
- [Code coverage](https://coveralls.io/github/cedx/which.php/)

## Other implementations
- Dart: [Where.dart](https://dev.belin.io/where.dart)
- JavaScript: [Which for JS](https://dev.belin.io/which.js)
- Dart: [Where.dart](https://docs.belin.io/where.dart)
- JavaScript: [Which for JS](https://docs.belin.io/which.js)

+ 0
- 44
doc/mkdocs.yaml View File

@@ -1,44 +0,0 @@
site_name: Which for PHP
site_description: Find the instances of an executable in the system path, implemented in PHP.
site_author: Cédric Belin - cedric@belin.io
site_url: https://dev.belin.io/which.php

docs_dir: .
site_dir: ../www

repo_name: GitHub
repo_url: https://github.com/cedx/which.php
edit_uri: ''

copyright: Copyright © 2017 - 2020 Cédric Belin
google_analytics:
- !!python/object/apply:os.getenv [GOOGLE_ANALYTICS_ID]
- auto

extra:
social:
- {type: globe, link: 'https://belin.io'}
- {type: github, link: 'https://github.com/cedx'}
- {type: twitter, link: 'https://twitter.com/cedxbelin'}
- {type: linkedin, link: 'https://linkedin.com/in/cedxbelin'}

markdown_extensions:
- admonition
- codehilite
- meta

nav:
- Overview: index.md
- Installation: installation.md
- Usage:
- Programming interface: usage/api.md
- Command line interface: usage/cli.md
- About:
- Changelog: about/changelog.md
- License: about/license.md
- See also: about/see_also.md

theme:
name: material
favicon: img/favicon.ico
palette: {primary: deep purple, accent: deep purple}

+ 3
- 1
doc/usage/api.md View File

@@ -1,5 +1,7 @@
path: blob/master
---
path: src/branch/master
source: src/which.php
---

# Application programming interface
This package provides a single function, `Which\which()`, allowing to locate a command in the system path:


+ 3
- 1
doc/usage/cli.md View File

@@ -1,5 +1,7 @@
path: blob/master
---
path: src/branch/master
source: bin/which
---

# Command line interface
From a command prompt, install the `which` executable:


+ 50
- 0
etc/mkdocs.yaml View File

@@ -0,0 +1,50 @@
site_name: Which for PHP
site_description: Find the instances of an executable in the system path, in PHP. Like the `which` Linux command.
site_author: Cédric Belin - cedric@belin.io
site_url: https://docs.belin.io/which.php

docs_dir: ../doc
site_dir: ../www

repo_name: git.belin.io
repo_url: https://git.belin.io/cedx/which.php
edit_uri: ''

copyright: Copyright © 2017 - 2020 Cédric Belin
extra:
social:
- icon: fontawesome/solid/globe
link: 'https://belin.io'
- icon: fontawesome/brands/github
link: 'https://github.com/cedx'
- icon: fontawesome/brands/twitter
link: 'https://twitter.com/cedxbelin'
- icon: fontawesome/brands/linkedin
link: 'https://linkedin.com/in/cedxbelin'

markdown_extensions:
- admonition
- codehilite
- meta
- toc:
permalink: true

nav:
- Overview: index.md
- Installation: installation.md
- Usage:
- Programming interface: usage/api.md
- Command line interface: usage/cli.md
- About:
- License: about/license.md
- See also: about/see_also.md

theme:
icon:
logo: fontawesome/solid/book-reader
repo: fontawesome/brands/git-alt
name: material
favicon: img/favicon.ico
palette:
accent: purple
primary: purple

+ 1
- 0
etc/requirements.txt View File

@@ -0,0 +1 @@
mkdocs-material

+ 6
- 0
readthedocs.yaml View File

@@ -0,0 +1,6 @@
version: 2
mkdocs:
configuration: etc/mkdocs.yaml
python:
install:
- requirements: etc/requirements.txt