Skip to content

Commit a7ba661

Browse files
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.

0 commit comments

Comments
 (0)