diff --git a/doxygen.conf b/doxygen/doxygen.conf similarity index 99% rename from doxygen.conf rename to doxygen/doxygen.conf index 4db530d40..4b465074c 100644 --- a/doxygen.conf +++ b/doxygen/doxygen.conf @@ -737,9 +737,9 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = ./src \ - ./vendor/pocketmine \ - ./README.md +INPUT = ../src \ + ../vendor/pocketmine \ + ./index.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -881,7 +881,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = ./README.md +USE_MDFILE_AS_MAINPAGE = ./index.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/doxygen/index.md b/doxygen/index.md new file mode 100644 index 000000000..14b0fbe48 --- /dev/null +++ b/doxygen/index.md @@ -0,0 +1,10 @@ +## PocketMine-MP API Documentation + +This site contains auto-generated API documentation for PocketMine-MP (and dependencies which are not outsourced). Documentation here is regenerated for every release. + +This site can be accessed via https://apidoc.pmmp.io. + +### Additional developer resources + - [DevTools](https://github.com/pmmp/PocketMine-DevTools/) - Development tools plugin for creating plugins + - [ExamplePlugin](https://github.com/pmmp/ExamplePlugin/) - Example plugin demonstrating some basic API features + - [DeveloperDocs](https://github.com/pmmp/DeveloperDocs/) - Reference, guides and specifications for the PocketMine-MP API