Skip to content

Commit 2e1f0cd

Browse files
committed
:octocat: remove documentation features
1 parent 48e0605 commit 2e1f0cd

File tree

17 files changed

+19
-1159
lines changed

17 files changed

+19
-1159
lines changed

.github/workflows/ci.yml

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -103,63 +103,3 @@ jobs:
103103
# with:
104104
# token: ${{ secrets.CODECOV_TOKEN }}
105105
# files: .build/coverage/clover.xml
106-
107-
# - name: "Send code coverage report to Codacy"
108-
# uses: codacy/codacy-coverage-reporter-action@v1
109-
# with:
110-
# project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
111-
# coverage-reports: .build/coverage/clover.xml
112-
113-
114-
build-docs:
115-
name: "Build and publish API docs"
116-
if: github.ref_name == 'main'
117-
runs-on: ubuntu-latest
118-
119-
steps:
120-
- name: "Checkout sources"
121-
uses: actions/checkout@v4
122-
123-
- name: "Install PHP"
124-
uses: shivammathur/setup-php@v2
125-
with:
126-
php-version: "8.3"
127-
extensions: simplexml, ${{ env.PHP_EXTENSIONS }}
128-
ini-values: ${{ env.PHP_INI_VALUES }}
129-
coverage: none
130-
tools: phpDocumentor
131-
132-
- name: "Build API docs"
133-
run: phpdoc --config=phpdoc.xml.dist
134-
135-
- name: "Publish API docs to branch gh-pages"
136-
uses: JamesIves/github-pages-deploy-action@v4
137-
with:
138-
branch: gh-pages
139-
folder: .build/phpdocs
140-
clean: true
141-
142-
143-
build-manual:
144-
name: "Build and publish user manual"
145-
if: github.ref_name == 'main'
146-
runs-on: ubuntu-latest
147-
148-
steps:
149-
- name: "Checkout sources"
150-
uses: actions/checkout@v4
151-
152-
- name: "Install Sphinx"
153-
run: pip install sphinx myst-parser sphinx-rtd-theme
154-
155-
- name: "Build manual"
156-
run: |
157-
cd docs
158-
make html
159-
160-
- name: "Publish user manual to branch readthedocs"
161-
uses: JamesIves/github-pages-deploy-action@v4
162-
with:
163-
branch: readthedocs
164-
folder: .build/sphinx/html
165-
clean: true

.phpdoc/template/base.html.twig

Lines changed: 0 additions & 12 deletions
This file was deleted.

.readthedocs.yml

Lines changed: 0 additions & 31 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,46 @@
1-
# chillerlan/php-library-template
1+
# chillerlan/php-library-template-nodocs
22

3-
A template/boilerplate for PHP libraries.
3+
A template/boilerplate for PHP libraries (similar to [chillerlan/php-library-template](https://github.com/chillerlan/php-library-template) but without phpdocs and readthedocs deployment).
44

55
[![PHP Version Support][php-badge]][php]
66
[![Packagist version][packagist-badge]][packagist]
77
[![License][license-badge]][license]
88
[![Continuous Integration][gh-action-badge]][gh-action]
99
[![CodeCov][coverage-badge]][coverage]
10-
[![Codacy][codacy-badge]][codacy]
1110
[![Packagist downloads][downloads-badge]][downloads]
1211

13-
[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-library-template?logo=php&color=8892BF&logoColor=fff
12+
[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-library-template-nodocs?logo=php&color=8892BF&logoColor=fff
1413
[php]: https://www.php.net/supported-versions.php
15-
[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-library-template.svg?logo=packagist&logoColor=fff
16-
[packagist]: https://packagist.org/packages/chillerlan/php-library-template
17-
[license-badge]: https://img.shields.io/github/license/chillerlan/php-library-template
18-
[license]: https://github.com/chillerlan/php-library-template/blob/main/LICENSE
19-
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-library-template/ci.yml?branch=main&logo=github&logoColor=fff
20-
[gh-action]: https://github.com/chillerlan/php-library-template/actions/workflows/ci.yml?query=branch%3Amain
21-
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-library-template.svg?logo=codecov&logoColor=fff
22-
[coverage]: https://codecov.io/github/chillerlan/php-library-template
23-
[codacy-badge]: https://img.shields.io/codacy/grade/917022229a8f432e9a15481ebf0c587c?logo=codacy&logoColor=fff
24-
[codacy]: https://app.codacy.com/gh/chillerlan/php-library-template/dashboard
25-
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-library-template.svg?logo=packagist&logoColor=fff
26-
[downloads]: https://packagist.org/packages/chillerlan/php-library-template/stats
14+
[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-library-template-nodocs.svg?logo=packagist&logoColor=fff
15+
[packagist]: https://packagist.org/packages/chillerlan/php-library-template-nodocs
16+
[license-badge]: https://img.shields.io/github/license/chillerlan/php-library-template-nodocs
17+
[license]: https://github.com/chillerlan/php-library-template-nodocs/blob/main/LICENSE
18+
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-library-template-nodocs/ci.yml?branch=main&logo=github&logoColor=fff
19+
[gh-action]: https://github.com/chillerlan/php-library-template-nodocs/actions/workflows/ci.yml?query=branch%3Amain
20+
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-library-template-nodocs.svg?logo=codecov&logoColor=fff
21+
[coverage]: https://codecov.io/github/chillerlan/php-library-template-nodocs
22+
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-library-template-nodocs.svg?logo=packagist&logoColor=fff
23+
[downloads]: https://packagist.org/packages/chillerlan/php-library-template-nodocs/stats
2724

2825
## Overview
2926

3027
### Features
3128

32-
- [GitHub Actions](https://github.com/chillerlan/php-library-template/actions) runner
29+
- [GitHub Actions](https://github.com/chillerlan/php-library-template-nodocs/actions) runner
3330
- [Composer](https://getcomposer.org) dependency management
3431
- [PHPUnit](https://phpunit.de) unit tests
3532
- [PHAN](https://github.com/phan/phan) static analysis
3633
- [PHPCS](https://github.com/PHPCSStandards/PHP_CodeSniffer) coding standard analyzer
3734
- [PHPMD](https://phpmd.org) mess detector
3835
- [Codecov](https://codecov.io) code coverage analysis
39-
- [Codacy](https://www.codacy.com) code quality analysis
4036
- [phpDocumentor](https://www.phpdoc.org) auto generated API docs
41-
- [ReadTheDocs](https://readthedocs.org) documentation builder
4237

4338

4439
### Requirements
4540

4641
- PHP 8.1+
4742

4843

49-
## Documentation
50-
51-
- The user manual is at https://php-library-template.readthedocs.io/ ([sources](https://github.com/chillerlan/php-library-template/tree/main/docs))
52-
- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-library-template/
53-
54-
5544
## Disclaimer
5645

5746
Use at your own risk!

composer.json

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "chillerlan/php-library-template",
2+
"name": "chillerlan/php-library-template-nodocs",
33
"description": "A PHP Library template/boilerplate.",
44
"license": "MIT",
55
"type": "library",
@@ -12,7 +12,7 @@
1212
},
1313
{
1414
"name": "Contributors",
15-
"homepage":"https://github.com/chillerlan/php-library-template/graphs/contributors"
15+
"homepage":"https://github.com/chillerlan/php-library-template-nodocs/graphs/contributors"
1616
}
1717
],
1818
"funding": [
@@ -21,11 +21,10 @@
2121
"url": "https://ko-fi.com/codemasher"
2222
}
2323
],
24-
"homepage": "https://github.com/chillerlan/php-library-template",
24+
"homepage": "https://github.com/chillerlan/php-library-template-nodocs",
2525
"support": {
26-
"docs": "https://php-library-template.readthedocs.io",
27-
"issues": "https://github.com/chillerlan/php-library-template/issues",
28-
"source": "https://github.com/chillerlan/php-library-template"
26+
"issues": "https://github.com/chillerlan/php-library-template-nodocs/issues",
27+
"source": "https://github.com/chillerlan/php-library-template-nodocs"
2928
},
3029
"minimum-stability": "stable",
3130
"prefer-stable": true,

docs/Appendix/Contribute.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)