Skip to content

Commit d3d0ba6

Browse files
committed
Fix building the doc
1 parent 0a20793 commit d3d0ba6

34 files changed

+3084
-3065
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ This project uses:
1818

1919
* [PHP Code Sniffer](https://github.com/squizlabs/php_codesniffer) for checking PHP code style
2020
* [PHPUnit](http://phpunit.de/) for unit test (100% covered)
21-
* [sphpdox](https://packagist.org/packages/sphpdox/sphpdox) for [documentation](http://php-sorted-collections.readthedocs.io/en/latest/?badge=latest)
21+
* [Sphinx](https://www.sphinx-doc.org/) and [Doxygen](https://www.doxygen.nl/) for the
22+
[documentation](http://php-sorted-collections.readthedocs.io/en/latest/?badge=latest)
2223

2324
Instructions
2425
------------
2526

2627
Using composer: either
2728

28-
~~~bash
29+
~~~shell
2930
$ composer create-project chdemko/sorted-collections:1.0.*@dev; cd sorted-collections
3031
~~~
3132

@@ -41,18 +42,10 @@ or create a `composer.json` file containing
4142

4243
and run
4344

44-
~~~bash
45+
~~~shell
4546
$ composer install
4647
~~~
4748

48-
Run also
49-
50-
~~~bash
51-
$ [sudo] pip install [--user] -r docs/requirements.txt
52-
~~~
53-
54-
if you want to create local documentation.
55-
5649
Create a `test.php` file containg
5750

5851
~~~php
@@ -70,7 +63,7 @@ echo $tree . PHP_EOL;
7063

7164
And run
7265

73-
~~~bash
66+
~~~shell
7467
$ php test.php
7568
~~~
7669

@@ -82,6 +75,24 @@ This should print
8275

8376
See the [examples](https://github.com/chdemko/php-sorted-collections/tree/develop/examples) and [benchmarks](https://github.com/chdemko/php-sorted-collections/tree/develop/benchmarks) folder for more information.
8477

78+
Documentation
79+
-------------
80+
81+
Run
82+
83+
~~~shell
84+
$ sudo apt install doxygen python3-pip python3-virtualenv
85+
$ virtualenv venv
86+
$ venv/bin/activate
87+
(venv) $ pip install -r docs/requirements.txt
88+
(venv) $ sphinx-build -b html docs/ html/
89+
(venv) $ deactivate
90+
$
91+
~~~
92+
93+
if you want to create local documentation with Sphinx.
94+
95+
8596
Citation
8697
--------
8798

composer.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
"php-coveralls/php-coveralls": "^2.5",
2121
"squizlabs/php_codesniffer": "3.*",
2222
"phpunit/phpunit": "^10.2",
23-
"sphpdox/sphpdox": "dev-master",
2423
"phpbench/phpbench": "^1.2"
2524
},
2625
"autoload": {
@@ -36,10 +35,6 @@
3635
"scripts": {
3736
"style": "vendor/bin/phpcs --report=full --extensions=php --standard=PSR12 src tests examples benchmarks",
3837
"test": "XDEBUG_MODE=coverage vendor/bin/phpunit --log-junit junit.xml",
39-
"doc": [
40-
"vendor/bin/sphpdox process --output docs chdemko src",
41-
"sphinx-build -b html docs/ html/"
42-
],
4338
"benchmark": "vendor/bin/phpbench run --report=default"
4439
}
4540
}

0 commit comments

Comments
 (0)