Skip to content

Commit

Permalink
adding docs generated via sphpdox/sphpdox for ReadTheDocs service
Browse files Browse the repository at this point in the history
  • Loading branch information
salaros committed Nov 13, 2017
1 parent b325f64 commit c90d5ac
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
58 changes: 58 additions & 0 deletions docs/Scripts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
-----------------------------------
Salaros\\MrPress\\Composer\\Scripts
-----------------------------------

.. php:namespace: Salaros\\MrPress\\Composer
.. php:class:: Scripts
Composer scripts for Mr.Press installations

.. php:method:: init(Event $event)
Main method which initializes Scripts class instance

:type $event: Event
:param $event:
:returns: void

.. php:method:: createDatabase(Event $event)
Creating WordPress database via WP CLI by using configs loaded from .env
file

:type $event: Event
:param $event:
:returns: void

.. php:method:: createTables(Event $event)
Install WordPress by creating tables on the DB via WP CLI

:type $event: Event
:param $event:
:returns: void

.. php:method:: activatePlugins(Event $event)
Activate all currently installed plugins

:type $event: Event
:param $event:
:returns: void

.. php:method:: createCronjob(Event $event)
Create crontab entry for www-data user

:type $event: Event
:param $event:
:returns: void

.. php:method:: addSalts(Event $event)
Appends WordPress salts to .env file if needed

:type $event: Event
:param $event:
:returns: void
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
''''''''''''''''''''''''''
Salaros\\MrPress\\Composer
''''''''''''''''''''''''''

.. php:namespace: Salaros\\MrPress\\Composer
.. toctree::

Scripts

0 comments on commit c90d5ac

Please sign in to comment.