-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FEATURE] Document how to Regenerate existing code snippets
- Loading branch information
Showing
2 changed files
with
62 additions
and
5 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
.. include:: /Includes.rst.txt | ||
.. _codesnippet-generation: | ||
|
||
======================= | ||
Code snippet generation | ||
======================= | ||
|
||
.. todo: Document how to create additional code snippets | ||
.. _codesnippet-regeneration: | ||
|
||
Regenerate existing code snippets | ||
================================= | ||
|
||
To regenerate the existing code snippets in a manual or extension clone | ||
the repository of that manual. | ||
|
||
.. code-block:: bash | ||
git clone [email protected]:TYPO3-Documentation/TYPO3CMS-Reference-CoreApi.git | ||
Use composer to install all dependencies, | ||
including dev-dependencies. In official manuals we have a make command for | ||
your convenience. | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Make | ||
|
||
.. code-block:: bash | ||
make install | ||
.. tab:: composer | ||
|
||
.. code-block:: bash | ||
# in repositories where the composer.lock is not in version control | ||
composer update | ||
Then regenerate the code snippets. Official manuals should have a make command | ||
for that. | ||
|
||
.. tabs:: | ||
|
||
.. tab:: Make | ||
|
||
.. code-block:: bash | ||
make codesnippets | ||
.. tab:: TYPO3 console command | ||
|
||
.. code-block:: bash | ||
# Paths depends on where the vendor binaries are installed | ||
# And where the configuration file codesnippets.php is located | ||
vendor/bin/typo3 codesnippet:create Documentation/ |
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