-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Clean up badges in README file (#116) * improve badges * cleanup * wip * wip * wip * Configuration Elements cannot be replaced (#117) * Apply fixes from StyleCI * Update composer.json * Update release-drafter.yml * Update release-drafter.yml * Create bundler.yml * Add POC for "CRUD::addTo($app)" syntax (#123) * Add POC for "CRUD::addTo($app)" syntax * Apply fixes from StyleCI * Add unit tests * Apply fixes from StyleCI * remove this weird file * [REFACTOR] rename addHook to onHook with argument naming consistency (#124) * rename addHook to onHook with argument naming consistency * Apply fixes from StyleCI * rename addHook to onHook with argument naming consistency * update docs * hook $this by default (#126) * assign $this as default value for fx * update exception info * update docs * Move doc builder instructions into Docker (#125) * Releasing 2.0.1 into master (#122) * Clean up badges in README file (#116) * improve badges * cleanup * wip * wip * wip * Configuration Elements cannot be replaced (#117) * Apply fixes from StyleCI * Update composer.json * Update release-drafter.yml * Update release-drafter.yml * Create bundler.yml * Setting release dependencies Co-authored-by: Romans Malinovskis <me@nearly.guru> Co-authored-by: Georg Marx <bepixeld@users.noreply.github.com> Co-authored-by: Imants Horsts <DarkSide666@users.noreply.github.com> Co-authored-by: GitHub Web Flow <noreply@github.com> * Add POC for "CRUD::addTo($app)" syntax * Apply fixes from StyleCI * Add unit tests * Apply fixes from StyleCI * remove this weird file * Add dockerfile for easier doc preview * Update instructions * add doc integration instructions for PhpStorm * Add mention of addTo() into the docs Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Georg Marx <bepixeld@users.noreply.github.com> Co-authored-by: Imants Horsts <DarkSide666@users.noreply.github.com> Co-authored-by: GitHub Web Flow <noreply@github.com> * Rename hook spot argument (#127) * improve hook arguments versatility * rename $hookSpot to $spot * update tests * update comment * Apply fixes from StyleCI * improve hook default argument versatility * Apply fixes from StyleCI * Update unit-tests.yml * Update unit-tests.yml * Update unit-tests.yml * avoid code duplication (#128) * avoid code duplication * outline logic by using brackets * setLayout -> initLayout (#130) * setLayout -> initLayout * Apply fixes from StyleCI * style * Rename HEAD to develop for Composer in unit tests (#135) * Fix EOL to NL (#132) * Do not fail-fast PHP test matrix (#136) * Improve StaticAddToTrait trait (#139) * Fix initial StaticAddTo trait * Prevent bad addTo usage * Improve addTo method * Fix add_arguments in tests * Add similar method to addTo for seeds with class name * Improve readability and prevent even more bad usage * Fix typo * Improve StaticAddTo tests and add unsafe method for BC UI impl. (#140) * Improve StaticAddTo tests * Add unsafe method of addToWithClassName to skip instanceof check * Do not wrap exception message in array (#141) * Add skip_add param to StaticAddToTrait trait methods (#143) * Require class name in seed for addToWithClassName methods (#144) * Update release-drafter.yml * Update release-drafter.yml * Update StaticAddToTrait.php * Improve hooks and allow to delete/check specific priority (#133) * Improve hooks and allow to delete/check specific priority * Fix tests * Introduce indexes hooks * Fix hook doc * fix compatibility * Fix bad phpdoc * Add injection of solutions in Exception constructor (#119) * Rapid add solutions in constructor * Apply fixes from StyleCI * fixes * Apply fixes from StyleCI * style fix Co-authored-by: DarkSide <imants.horsts@inbox.lv> Co-authored-by: Imants Horsts <DarkSide666@users.noreply.github.com> * Fix CS - do not import classes without namespace (#147) * Fix CS - do not import classes without namespace * Apply fixes from StyleCI Co-authored-by: Romans Malinovskis <me@nearly.guru> * Align exception header properly (#148) * Setting release dependencies Co-authored-by: Romans Malinovskis <me@nearly.guru> Co-authored-by: Georg Marx <bepixeld@users.noreply.github.com> Co-authored-by: Imants Horsts <imants.horsts@inbox.lv> Co-authored-by: Imants Horsts <DarkSide666@users.noreply.github.com> Co-authored-by: Georgi Hristov <georgehristov@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: GitHub Web Flow <noreply@github.com> Co-authored-by: Michael Voříšek <mvorisek@mvorisek.cz> Co-authored-by: Francesco Danti <fdanti@gmail.com>
- Loading branch information
1 parent
6313f84
commit 56c4ab1
Showing
28 changed files
with
683 additions
and
263 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
FROM python:2-stretch as builder | ||
|
||
WORKDIR /www | ||
|
||
ADD requirements.txt . | ||
|
||
RUN pip install pip==9.0.1 wheel==0.29.0 \ | ||
&& pip install -r requirements.txt | ||
|
||
ADD . . | ||
|
||
RUN make html | ||
#RUN cp -R images build/html/images | ||
|
||
FROM nginx:latest | ||
|
||
COPY --from=builder /www/build/html /usr/share/nginx/html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,9 @@ | ||
How to build this documentation | ||
Our documentation can now be built in the Docker. | ||
|
||
``` | ||
sudo apt-get install python-sphinx python-setuptools | ||
sudo easy_install pip | ||
sudo pip install sphinx_rtd_theme | ||
sudo pip install sphinxcontrib-phpdomain | ||
make html | ||
docker build -t docs . | ||
docker run -p 8080:80 docs | ||
``` | ||
|
||
next open `html/index.html` in your browser | ||
|
||
``` | ||
open html/index.html | ||
``` | ||
|
||
Open http://localhost:8080/ in your browser. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
================ | ||
Writing ATK Docs | ||
================ | ||
|
||
New users of Agile Toolkit rely on documentation. To make it easier for the | ||
maintainers to update documentation - each component of ATK framework comes | ||
with a nice documentation builder. | ||
|
||
Writing ATK Documentation | ||
========================= | ||
|
||
Open file "docs/index.rst" in your editor. Most editors will support | ||
"reSTructured Text" through add-on. The support is not perfect, but it works. | ||
|
||
If you are updating a feature - find a corresponding ".rst" file. Your editor | ||
may be able to show you a preview. Modify or extend documentation as needed. | ||
|
||
See also: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html | ||
|
||
Building and Testing Documentation | ||
================================== | ||
|
||
Make sure you have "Docker" installed, follow simple instructions in | ||
"docs/README.md". | ||
|
||
Integrating PhpStorm | ||
-------------------- | ||
|
||
You can integrate PhpStorm build process like this: | ||
|
||
.. figure:: images/doc-build-phpstorm1.png | ||
:scale: 50 % | ||
:alt: Create build configuration for the Dockerfile | ||
|
||
|
||
.. figure:: images/doc-build-phpstorm2.png | ||
:scale: 50 % | ||
:alt: Adjust Port settings to expose 80 as 8080 | ||
|
||
.. figure:: images/doc-build-phpstorm3.png | ||
:scale: 50 % | ||
:alt: Use "Ctrl+R" anytime to build docs | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
sphinxcontrib-phpdomain | ||
sphinx_rtd_theme |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.