Browse Source

Updated the documentation

tags/v2.3.0
Cédric Belin 3 months ago
parent
commit
6a5ab5fd20
11 changed files with 67 additions and 35 deletions
  1. +5
    -5
      README.md
  2. +1
    -6
      RoboFile.php
  3. +3
    -3
      composer.json
  4. +20
    -0
      doc/about/license.md
  5. +3
    -3
      doc/about/see_also.md
  6. +2
    -2
      doc/installation.md
  7. +3
    -1
      doc/usage/api.md
  8. +3
    -1
      doc/usage/cli.md
  9. +20
    -14
      etc/mkdocs.yaml
  10. +1
    -0
      etc/requirements.txt
  11. +6
    -0
      readthedocs.yaml

+ 5
- 5
README.md View File

@@ -4,13 +4,13 @@
Open whatever you want in [PHP](https://www.php.net), such as URLs, files or executables, regardless of the platform you use.

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

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

## License
[Open.php](https://dev.belin.io/open.php) is distributed under the MIT License.
[Open.php](https://docs.belin.io/open.php) is distributed under the MIT License.

+ 1
- 6
RoboFile.php View File

@@ -54,13 +54,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": "Open whatever you want, such as URLs, files or executables, regardless of the platform you use.",
"homepage": "https://dev.belin.io/open.php",
"homepage": "https://docs.belin.io/open.php",
"license": "MIT",
"name": "cedx/open",
"type": "library",
@@ -47,7 +47,7 @@
"test": "robo test"
},
"support": {
"docs": "https://dev.belin.io/open.php/api",
"issues": "https://github.com/cedx/open.php/issues"
"docs": "https://api.belin.io/open.php",
"issues": "https://git.belin.io/cedx/open.php/issues"
}
}

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

@@ -0,0 +1,20 @@
# MIT License
Copyright © 2019 - 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.

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

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

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

## Other implementations
- Dart: [Open.dart](https://dev.belin.io/open.dart)
- Dart: [Open.dart](https://docs.belin.io/open.dart)

+ 2
- 2
doc/installation.md View File

@@ -11,10 +11,10 @@ You can verify if you're already good to go with the following commands:

```shell
php --version
# PHP 7.4.4 (cli) (built: Mar 17 2020 13:49:13) ( NTS Visual C++ 2017 x64 )
# PHP 7.4.5 (cli) (built: Apr 14 2020 16:17:19) ( NTS Visual C++ 2017 x64 )

composer --version
# Composer version 1.10.1 2020-03-13 20:34:27
# Composer version 1.10.5 2020-04-10 11:44:22
```

!!! info


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

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

# Application programming interface
This package provides a single function, `Open\open()`, allowing to open a document or URL:


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

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

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


doc/mkdocs.yaml → etc/mkdocs.yaml View File

@@ -1,31 +1,33 @@
site_name: Open.php
site_description: Open whatever you want in PHP, such as URLs, files or executables, regardless of the platform you use.
site_author: Cédric Belin - cedric@belin.io
site_url: https://dev.belin.io/open.php
site_url: https://docs.belin.io/open.php

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

repo_name: GitHub
repo_url: https://github.com/cedx/open.php
repo_name: git.belin.io
repo_url: https://git.belin.io/cedx/open.php
edit_uri: ''

copyright: Copyright © 2019 - 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'}
- 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
@@ -34,11 +36,15 @@ nav:
- 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:
icon:
logo: fontawesome/solid/book-reader
repo: fontawesome/brands/git-alt
name: material
favicon: img/favicon.ico
palette: {primary: deep purple, accent: deep purple}
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

Loading…
Cancel
Save