Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 4be1628

Browse filesBrowse files
committed
Remove Build the Documentation Locally
1 parent acb5fa2 commit 4be1628
Copy full SHA for 4be1628

File tree

Expand file treeCollapse file tree

1 file changed

+3
-42
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+3
-42
lines changed

‎contributing/documentation/overview.rst

Copy file name to clipboardExpand all lines: contributing/documentation/overview.rst
+3-42Lines changed: 3 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -246,44 +246,8 @@ GitHub, click on the **Show all checks** link and finally, click on the
246246
Only Pull Requests to maintained branches are automatically built by
247247
SymfonyCloud. Check the `roadmap`_ for maintained branches.
248248

249-
Build the Documentation Locally
250-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251-
252-
If you have Docker installed on your machine, run these commands to build the
253-
docs:
254-
255-
.. code-block:: terminal
256-
257-
# build the image...
258-
$ docker build . -t symfony-docs
259-
260-
# ...and start the local web server
261-
# (if it's already in use, change the '8080' port by any other port)
262-
$ docker run --rm -p 8080:80 symfony-docs
263-
264-
You can now read the docs at ``http://127.0.0.1:8080`` (if you use a virtual
265-
machine, browse its IP instead of localhost; e.g. ``http://192.168.99.100:8080``).
266-
267-
If you don't use Docker, follow these steps to build the docs locally:
268-
269-
#. Install `pip`_ as explained in the `pip installation`_ article;
270-
271-
#. Install `Sphinx`_ and `Sphinx Extensions for PHP and Symfony`_
272-
(depending on your system, you may need to execute this command as root user):
273-
274-
.. code-block:: terminal
275-
276-
$ cd _build/
277-
$ pip install -r .requirements.txt
278-
279-
#. Run the following command to build the documentation in HTML format:
280-
281-
.. code-block:: terminal
282-
283-
$ cd _build/
284-
$ make html
285-
286-
The generated documentation is available in the ``_build/html`` directory.
249+
To build a local copy of the documentation to review your changes, see the
250+
`Build the Documentation Locally`_ section in the README file.
287251

288252
Frequently Asked Questions
289253
--------------------------
@@ -342,7 +306,4 @@ definitely don't want you to waste your time!
342306
.. _`Symfony Documentation Badge`: https://connect.symfony.com/badge/36/symfony-documentation-contributor
343307
.. _`SymfonyCloud`: https://symfony.com/cloud
344308
.. _`roadmap`: https://symfony.com/releases
345-
.. _`pip`: https://pip.pypa.io/en/stable/
346-
.. _`pip installation`: https://pip.pypa.io/en/stable/installing/
347-
.. _`Sphinx`: https://www.sphinx-doc.org/
348-
.. _`Sphinx Extensions for PHP and Symfony`: https://github.com/fabpot/sphinx-php
309+
.. _`Build the Documentation Locally`: https://github.com/symfony/symfony-docs#build-documentation-locally

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.