Skip to content

Update the instructions to build docs #16068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .dockerignore

This file was deleted.

5 changes: 0 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,2 @@
/_build/doctrees
/_build/spelling
/_build/html
/_build/logs.txt
/_build/vendor
/_build/output
*.pyc
20 changes: 0 additions & 20 deletions Dockerfile

This file was deleted.

37 changes: 15 additions & 22 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,27 @@
Contributing
------------

We love contributors! For more information on how you can contribute to the
Symfony documentation, please read
[Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html)
We love contributors! For more information on how you can contribute, please read
the [Symfony Docs Contributing Guide](https://symfony.com/doc/current/contributing/documentation/overview.html)

> **Note**
> All pull requests must be based on the ``4.4`` branch,
> unless you are documenting a feature that was introduced *after* Symfony 4.4
> (e.g. in Symfony 5.2), **not** the ``5.x`` or older branches.
**Important**: use `4.4` branch as the base of your pull requests, unless you are
documenting a feature that was introduced *after* Symfony 4.4 (e.g. in Symfony 5.2).

SymfonyCloud
------------
Build Documentation Locally
---------------------------

Thanks to [SymfonyCloud](https://symfony.com/cloud) for providing an integration
server where Pull Requests are built and can be reviewed by contributors.
This is not needed for contributing, but it's useful if you want to debug some
issue in the docs or if you want to read Symfony Documentation offline.

Docker
------
```bash
$ git clone git@github.com:symfony/symfony-docs.git

You can build the documentation project locally with these commands:
$ cd symfony-docs/
$ cd _build/

```bash
# build the image...
$ docker build . -t symfony-docs
$ composer install

# ...and start the local web server
# (if it's already in use, change the '8080' port by any other port)
$ docker run --rm -p 8080:80 symfony-docs
$ php build.php
```

You can now read the docs at http://127.0.0.1:8080 (if you use a virtual
machine, browse its IP instead of localhost; e.g. `http://192.168.99.100:8080`).
Now you can browse the docs at `_build/output/index.html`
6 changes: 0 additions & 6 deletions _build/.requirements.txt

This file was deleted.

153 changes: 0 additions & 153 deletions _build/Makefile

This file was deleted.

Empty file.
86 changes: 0 additions & 86 deletions _build/_exts/symfonycom/sphinx/__init__.py

This file was deleted.

23 changes: 0 additions & 23 deletions _build/_exts/symfonycom/sphinx/lexer.py

This file was deleted.

23 changes: 0 additions & 23 deletions _build/_static/rtd_custom.css

This file was deleted.

1 change: 0 additions & 1 deletion _build/_static/symfony-logo.svg

This file was deleted.

Loading