mirror/Arsse
1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2024-12-22 21:22:40 +00:00
Code Issues Activity

Add served manual to Robo tasks

Browse source
This commit is contained in:
J. King 2019-01-25 16:56:05 -05:00
parent 6ce1f68ed7
commit e07253867c
2 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
RoboFile.php
View file

@ -6,8 +6,7 @@ class RoboFile extends \Robo\Tasks {
const BASE = __DIR__.\DIRECTORY_SEPARATOR; const BASE = __DIR__.\DIRECTORY_SEPARATOR;
const BASE_TEST = self::BASE."tests".\DIRECTORY_SEPARATOR; const BASE_TEST = self::BASE."tests".\DIRECTORY_SEPARATOR;
/** /** Runs the typical test suite
* Runs the typical test suite
* *
* Arguments passed to the task are passed on to PHPUnit. Thus one may, for * Arguments passed to the task are passed on to PHPUnit. Thus one may, for
* example, run the following command and get the expected results: * example, run the following command and get the expected results:
@ -20,8 +19,7 @@ class RoboFile extends \Robo\Tasks {
return $this->runTests(escapeshellarg(\PHP_BINARY), "typical", $args); return $this->runTests(escapeshellarg(\PHP_BINARY), "typical", $args);
} }
/** /** Runs the full test suite
* Runs the full test suite
* *
* This includes pedantic tests which may help to identify problems. * This includes pedantic tests which may help to identify problems.
* See help for the "test" task for more details. * See help for the "test" task for more details.
@ -171,8 +169,18 @@ class RoboFile extends \Robo\Tasks {
return $out; return $out;
} }
/** Generates static manual pages in the "manual" directory
*
* The resultant files are suitable for offline viewing and inclusion into release builds
*/
public function manual(array $args): Result { public function manual(array $args): Result {
$execpath = escapeshellarg(realpath(self::BASE."vendor/bin/daux")); $execpath = escapeshellarg(realpath(self::BASE."vendor/bin/daux"));
return $this->taskExec($execpath)->arg("generate")->option("-d", self::BASE."manual")->args($args)->run(); return $this->taskExec($execpath)->arg("generate")->option("-d", self::BASE."manual")->args($args)->run();
} }
/** Serves a live view of the manual using PHP's built-in Web server */
public function manualLive(array $args): Result {
$execpath = escapeshellarg(realpath(self::BASE."vendor/bin/daux"));
return $this->taskExec($execpath)->arg("serve")->args($args)->run();
}
} }

2
docs/en/030_Supported_Protocols/020_Tiny_Tiny_RSS.md
View file

@ -4,7 +4,7 @@
The Arsse supports not only the Tiny Tiny RSS protocol, but also extensions required by the FeedReader client and the more commonly supported `getCompactHeadlines` extension. The Arsse supports not only the Tiny Tiny RSS protocol, but also extensions required by the FeedReader client and the more commonly supported `getCompactHeadlines` extension.
It allows organizing newsfeeds into nested folders, and supports odd patchwork subset of Tiny Tiny RSS' full capabilities. The FeedReader extensions round out the protocol with significantly more features. Unlike TT-RSS itself, API access is always enabled with The Arsse. It allows organizing newsfeeds into nested folders, and supports an odd patchwork subset of Tiny Tiny RSS' full capabilities. The FeedReader extensions round out the protocol with significantly more features. Unlike TT-RSS itself, API access is always enabled with The Arsse.
<dl> <dl>
<dt>Supported since</dt> <dt>Supported since</dt>