8000 minor #39 Deleting index files - using globbing (weaverryan, WouterJ) · symfony/symfony-docs@a7ba661 · GitHub
[go: up one dir, main page]
Skip to content

Commit a7ba661

Browse files
javiereguiluzjaviereguiluz
committed
minor #39 Deleting index files - using globbing (weaverryan, WouterJ)
This PR was merged into the 2.7 branch. Discussion ---------- Deleting index files - using globbing This is a proof-of-concept for part of #26 - removing the `index.rst` and `map.rst.inc` files. I've done this for components only: * `components/index.rst` is NOT hidden, and the map is deleted. This gives us less control over how the components page is rendered... but I don't think it's a problem - that page is/was just a big list of links * `components/index.rst` uses `*` to include *everything* automatically * If you want one article to appear before others with globbing, you can list it before the `*` - see `components/index.rst` * At the bottom of each component article that contains related articles, I added a visible index that globs all the files from its directory (see `console.rst`). I also updated the component titles to include the packagist name on its own commit. Commits ------- dccb6f8 Fix build errors 026be06 Removed topics index pages 26f2f88 Fix wrong redirections de9840b Fix include path 84ee24d Include topics in main Index page bd192fa Fixing bad title 1324fc0 Deleting index files - using globbing
2 parents 96f7cdc + dccb6f8 commit a7ba661

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+367
-681
lines changed

‎assetic.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Assetic
2+
=======
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
:glob:
7+
8+
assetic/*

‎assetic/index.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎cache/index.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎components/class_loader.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
.. toctree::
2-
:hidden:
3-
:glob:
4-
5-
class_loader/*
6-
71
.. index::
82
single: Components; ClassLoader
93

@@ -35,7 +29,7 @@ which makes it possible
3529
:doc:`to cache the results of a class loader </components/class_loader/cache_class_loader>`.
3630

3731
When using the :doc:`Debug component </components/debug>`, you
38-
can also use a special :doc:`DebugClassLoader </components/debug/class_loader>`
32+
can also use a special :ref:`DebugClassLoader <component-debug-class-loader>`
3933
that eases debugging by throwing more helpful exceptions when a class could
4034
not be found by a class loader.
4135

@@ -50,6 +44,16 @@ You can install the component in 2 different ways:
5044

5145
.. include:: /components/require_autoload.rst.inc
5246

47+
Learn More
48+
----------
49+
50+
.. toctree::
51+
:glob:
52+
:maxdepth: 1
53+
54+
class_loader/class_loader
55+
class_loader/*
56+
5357
.. _PSR-0: http://www.php-fig.org/psr/psr-0/
5458
.. _PSR-4: http://www.php-fig.org/psr/psr-4/
5559
.. _`autoloading mechanism`: http://php.net/manual/en/language.oop5.autoload.php

‎components/class_loader/debug_class_loader.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Debugging a Class Loader
55

66
The ``DebugClassLoader`` from the ClassLoader component was deprecated
77
in Symfony 2.5 and will be removed in Symfony 3.0. Use the
8-
:doc:`DebugClassLoader provided by the Debug component </components/debug/class_loader>`.
8+
:ref:`DebugClassLoader provided by the Debug component <component-debug-class-loader>`.

‎components/class_loader/index.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎components/config.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,13 @@ You can install the component in 2 different ways:
2020

2121
.. include:: /components/require_autoload.rst.inc
2222

23-
Sections
24-
--------
23+
Learn More
24+
----------
2525

26-
* :doc:`/components/config/resources`
27-
* :doc:`/components/config/caching`
28-
* :doc:`/components/config/definition`
26+
.. toctree::
27+
:maxdepth: 1
28+
:glob:
29+
30+
config/*
2931

3032
.. _Packagist: https://packagist.org/packages/symfony/config

‎components/config/index.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎components/console.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -571,14 +571,15 @@ returns the returned code from the command (return value from command's
571571
command from the Web, refactor your code and move the logic to a new
572572
class.
573573

574-
Learn More!
575-
-----------
576-
577-
* :doc:`/components/console/usage`
578-
* :doc:`/components/console/single_command_tool`
579-
* :doc:`/components/console/changing_default_command`
580-
* :doc:`/components/console/events`
581-
* :doc:`/components/console/console_arguments`
574+
Learn More
575+
----------
576+
577+
.. toctree::
578+
:maxdepth: 1
579+
:glob:
580+
581+
console/*
582+
console/helpers/index
582583

583584
.. _Packagist: https://packagist.org/packages/symfony/console
584585
.. _Cmder: http://cmder.net/

‎components/console/index.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎components/debug.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,10 @@ and more useful::
7373
available, the handler uses a Symfony Response object; if not, it falls
7474
back to a regular PHP response.
7575

76+
.. _component-debug-class-loader:
77+
7678
Debugging a Class Loader
77-
========================
79+
------------------------
7880

7981
The :class:`Symfony\\Component\\Debug\\DebugClassLoader` attempts to
8082
throw more helpful exceptions when a class isn't found by the registered

‎components/dependency_injection.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,5 +286,13 @@ config files:
286286
->register('newsletter_manager', 'NewsletterManager')
287287
->addMethodCall('setMailer', array(new Reference('mailer')));
288288
289-
.. _Packagist: https://packagist.org/packages/symfony/dependency-injection
289+
Learn More
290+
----------
291+
292+
.. toctree::
293+
:maxdepth: 1
294+
:glob:
290295

296+
dependency_injection/*
297+
298+
.. _Packagist: https://packagist.org/packages/symfony/dependency-injection

‎components/dependency_injection/index.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎components/event_dispatcher.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,15 @@ with some other dispatchers:
512512
* :doc:`/components/event_dispatcher/traceable_dispatcher` (provided by the
513513
:doc:`HttpKernel component </components/http_kernel>`)
514514

515+
Learn More
516+
----------
517+
518+
.. toctree::
519+
:maxdepth: 1
520+
:glob:
521+
522+
event_dispatcher/*
523+
515524
.. _Mediator: https://en.wikipedia.org/wiki/Mediator_pattern
516525
.. _Closures: http://php.net/manual/en/functions.anonymous.php
517526
.. _PHP callable: http://www.php.net/manual/en/language.pseudo-types.php#language.types.callback

‎components/event_dispatcher/index.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎components/expression_language.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,4 +112,13 @@ Caching
112112
The component provides some different caching strategies, read more about them
113113
in :doc:`/components/expression_language/caching`.
114114

115+
Learn More
116+
----------
117+
118+
.. toctree::
119+
:maxdepth: 1
120+
:glob:
121+
122+
expression_language/*
123+
115124
.. _Packagist: https://packagist.org/packages/symfony/expression-language

‎components/expression_language/index.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎components/filesystem.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,4 +266,13 @@ Whenever something wrong happens, an exception implementing
266266
An :class:`Symfony\\Component\\Filesystem\\Exception\\IOException` is
267267
thrown if directory creation fails.
268268

269+
Learn More
270+
----------
271+
272+
.. toctree::
273+
:maxdepth: 1
274+
:glob:
275+
276+
filesystem/*
277+
269278
.. _`Packagist`: https://packagist.org/packages/symfony/filesystem

‎components/filesystem/index.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎components/form.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -702,6 +702,15 @@ method to access the list of errors. It returns a
702702
This is useful, for example, if you want to use PHP's ``array_`` function
703703
on the form errors.
704704

705+
Learn More
706+
----------
707+
708+
.. toctree::
709+
:maxdepth: 1
710+
:glob:
711+
712+
form/*
713+
705714
.. _Packagist: https://packagist.org/packages/symfony/form
706715
.. _Twig: http://twig.sensiolabs.org
707716
.. _`Twig Configuration`: http://twig.sensiolabs.org/doc/intro.html

‎components/form/index.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎components/http_foundation.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,15 @@ Session
596596

597597
The session information is in its own document: :doc:`/components/http_foundation/sessions`.
598598

599+
Learn More
600+
----------
601+
602+
.. toctree::
603+
:maxdepth: 1
604+
:glob:
605+
606+
http_foundation/*
607+
599608
.. _Packagist: https://packagist.org/packages/symfony/http-foundation
600609
.. _Nginx: http://wiki.nginx.org/XSendfile
601610
.. _Apache: https://tn123.org/mod_xsendfile/

‎components/http_foundation/index.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎components/index.rst

Lines changed: 4 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,51 +2,8 @@ The Components
22
==============
33

44
.. toctree::
5-
:hidden:
6-
5+
:maxdepth: 1
6+
:glob:
7+
78
using_components
8-
asset
9-
browser_kit
10-
class_loader
11-
class_loader/index
12-
config
13-
config/index
14-
console
15-
console/index
16-
css_selector
17-
debug
18-
dependency_injection
19-
dependency_injection/index
20-
dom_crawler
21-
event_dispatcher
22-
event_dispatcher/index
23-
expression_language
24-
expression_language/index
25-
filesystem
26-
filesystem/index
27-
finder
28-
form
29-
form/index
30-
http_foundation
31-
http_foundation/index
32-
http_kernel
33-
intl
34-
options_resolver
35-
phpunit_bridge
36-
process
37-
property_access
38-
routing
39-
security
40-
security/index
41-
serializer
42-
stopwatch
43-
templating
44-
templating/index
45-
translation
46-
translation/index
47-
var_dumper
48-
var_dumper/index
49-
yaml
50-
yaml/index
51-
52-
.. include:: /components/map.rst.inc
9+
*

0 commit comments

Comments
 (0)
0