mirror of
https://github.com/nextcloud/documentation.git
synced 2025-12-14 00:19:22 +07:00
committed by
Morris Jobke
parent
67a61197a0
commit
06086446bf
8
.gitignore
vendored
8
.gitignore
vendored
@@ -3,7 +3,12 @@
|
||||
|
||||
# Generated Files
|
||||
*/_build/*
|
||||
conf.pyc
|
||||
build/vendor/
|
||||
build/server/
|
||||
build/composer.lock
|
||||
developer_manual/api/
|
||||
|
||||
*.pyc
|
||||
|
||||
# Meta Data
|
||||
.DS_Store
|
||||
@@ -17,3 +22,4 @@ conf.pyc
|
||||
/nbproject/*
|
||||
*.db
|
||||
*.snag
|
||||
|
||||
|
||||
6
Makefile
6
Makefile
@@ -40,10 +40,10 @@ developer-manual-pdf:
|
||||
@echo "Developer manual build finished; PDF is updated"
|
||||
|
||||
api-docs: clean-api-docs
|
||||
cd build && sh get-server-sources.sh master
|
||||
mkdir -p developer_manual/api/
|
||||
sh get-server-sources.sh master
|
||||
composer install
|
||||
php generateApiDoc.php
|
||||
cd build && composer install && composer update
|
||||
cd build && php generateApiDoc.php
|
||||
|
||||
clean: clean-api-docs
|
||||
rm -r admin_manual/_build developer_manual/_build developer_manual/api user_manual/_build user_manual_de_/_build
|
||||
|
||||
@@ -1076,7 +1076,8 @@ img.desaturate {
|
||||
h1:hover a.headerlink,
|
||||
h2:hover a.headerlink,
|
||||
h3:hover a.headerlink,
|
||||
h4:hover a.headerlink {
|
||||
h4:hover a.headerlink,
|
||||
.phpdoctorst dt:hover a.headerlink {
|
||||
display: inline;
|
||||
}
|
||||
a.headerlink {
|
||||
@@ -1212,33 +1213,6 @@ li > dl > dt {
|
||||
|
||||
/* API doc styles */
|
||||
|
||||
/** Hacky way to display visibility since sphinx-phpdomain currently doesn't seem support them */
|
||||
|
||||
.public:before {
|
||||
content: 'public ';
|
||||
}
|
||||
.private:before {
|
||||
content: 'private ';
|
||||
}
|
||||
.protected:before {
|
||||
content: 'protected ';
|
||||
}
|
||||
.final dt:before{
|
||||
content: 'final ';
|
||||
}
|
||||
.abstract dt:before {
|
||||
content: 'abstract ';
|
||||
}
|
||||
|
||||
/* Apply rtd default styling to prepended visibility strings */
|
||||
.public:before, .private:before {
|
||||
float: left;
|
||||
}
|
||||
.abstract dt:before,
|
||||
.final dt:before {
|
||||
padding-right: 10px;
|
||||
}
|
||||
|
||||
dl.class dt,
|
||||
dl.interface dt,
|
||||
dl.trait dt {
|
||||
@@ -1256,18 +1230,6 @@ dl.trait dt {
|
||||
font-family: Monaco,Menlo,Consolas,"Courier New",monospace;
|
||||
font-size: 90%;
|
||||
}
|
||||
.method:before,
|
||||
.class:before,
|
||||
.interface:before,
|
||||
.trait:before,
|
||||
.namespace:before {
|
||||
padding-left: 10px;
|
||||
padding-top: 1px;
|
||||
background-color: #eeeeee;
|
||||
font-family: Monaco,Menlo,Consolas,"Courier New",monospace;
|
||||
font-size: 90%;
|
||||
margin-right: 10px;
|
||||
}
|
||||
.method > dt code,
|
||||
.class > dt code,
|
||||
.interface > dt code,
|
||||
|
||||
@@ -33,13 +33,12 @@ $nextcloudSource = [
|
||||
__DIR__ . '/server/lib/public',
|
||||
__DIR__ . '/server/lib/private',
|
||||
];
|
||||
$destinationDirectory = __DIR__ . '/developer_manual/api';
|
||||
$destinationDirectory = __DIR__ . '/../developer_manual/api';
|
||||
|
||||
$apiDocBuilder = new ApiDocBuilder($nextcloudSource, $destinationDirectory);
|
||||
$apiDocBuilder->setVerboseOutput(true);
|
||||
$apiDocBuilder->setDebugOutput(true);
|
||||
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\InterfaceImplementors::class);
|
||||
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\TocExtension::class);
|
||||
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\PublicOnlyExtension::class);
|
||||
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\NoPrivateExtension::class);
|
||||
$apiDocBuilder->addExtension(\JuliusHaertl\PHPDocToRst\Extension\GithubLocationExtension::class, [__DIR__ . '/server/', 'https://github.com/nextcloud/server']);
|
||||
$apiDocBuilder->build();
|
||||
|
||||
23
developer_manual/api.rst
Normal file
23
developer_manual/api.rst
Normal file
@@ -0,0 +1,23 @@
|
||||
API Documentation
|
||||
=================
|
||||
|
||||
|
||||
PHP public API
|
||||
--------------
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
/OCP namespace <api/OCP/index>
|
||||
|
||||
|
||||
PHP class reference
|
||||
-------------------
|
||||
|
||||
Please note that only APIs in \OCP namespace are considered to be public. The
|
||||
following documentation is just for reference:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
/ namespace <api/index>
|
||||
/OC namespace <api/OC/index>
|
||||
Reference in New Issue
Block a user