More refactoring of __init__ files

Author: kwankyu

src/doc/en/reference/combinat/module_list.rst

@@ -1,4 +1,4 @@
-Comprehensive Module list
+Comprehensive Module List
 =========================
 
 .. NOTE::
@@ -364,7 +364,7 @@ Comprehensive Module list
     sage/combinat/tutorial
     sage/combinat/vector_partition
     sage/combinat/words/abstract_word
-    sage/combinat/words/all
+    sage/combinat/words
     sage/combinat/words/alphabet
     sage/combinat/words/finite_word
     sage/combinat/words/infinite_word

src/sage/categories/all.py

@@ -27,6 +27,8 @@
 from sage.misc.namespace_package import install_doc
 install_doc(__package__, __doc__)
 
+from . import primer
+
 from sage.misc.lazy_import import lazy_import
 
 from .category import Category

src/sage/combinat/all.py

@@ -26,7 +26,7 @@
 - :ref:`sage.combinat.species.all`
 - :ref:`sage.combinat.designs.all`
 - :ref:`sage.combinat.posets.all`
-- :ref:`sage.combinat.words.all`
+- :ref:`sage.combinat.words`
 
 Utilities
 ---------
@@ -48,6 +48,8 @@
 from sage.misc.namespace_package import install_doc
 install_doc(__package__, __doc__)
 
+from . import quickref, tutorial
+
 from sage.misc.lazy_import import lazy_import
 
 from .combinat import bell_number, catalan_number, euler_number, fibonacci, \

src/sage/combinat/crystals/all.py

@@ -19,7 +19,7 @@
   :class:`FiniteCrystals`, :class:`ClassicalCrystals`, :class:`RegularCrystals`,
   :class:`~sage.categories.regular_supercrystals.RegularSuperCrystals`
   -- The categories for crystals
-- :ref:`sage.combinat.root_system`
+- :ref:`sage.combinat.root_system.all`
 """
 # install the docstring of this module to the containing package
 from sage.misc.namespace_package import install_doc

src/sage/combinat/root_system/all.py

@@ -14,7 +14,7 @@
 Introductory material
 ---------------------
 
-- :ref:`sage.combinat.root_system`                -- This overview
+- :ref:`sage.combinat.root_system.all`            -- This overview
 - :class:`CartanType`                             -- An introduction to Cartan types
 - :class:`RootSystem`                             -- An introduction to root systems
 - :ref:`sage.combinat.root_system.plot`           -- A root system visualization tutorial
@@ -25,7 +25,7 @@
 Related material
 ----------------
 
-- :ref:`sage.combinat.crystals`                   -- Crystals
+- :ref:`sage.combinat.crystals.all`               -- Crystals
 
 Cartan datum
 ------------
@@ -39,7 +39,7 @@
 Root systems
 ------------
 
-- :ref:`sage.combinat.root_system.root_system`
+- :ref:`sage.combinat.root_system.all`
 - :ref:`sage.combinat.root_system.plot`
 - :ref:`sage.combinat.root_system.root_lattice_realizations`
 - :ref:`sage.combinat.root_system.root_lattice_realization_algebras`
@@ -115,6 +115,9 @@
 - :ref:`sage.combinat.root_system.type_super_A`
 - :ref:`sage.combinat.root_system.type_A_infinity`
 """
+# install the docstring of this module to the containing package
+from sage.misc.namespace_package import install_doc
+install_doc(__package__, __doc__)
 
 from sage.misc.lazy_import import lazy_import
 
@@ -139,6 +142,3 @@
 lazy_import('sage.combinat.root_system.non_symmetric_macdonald_polynomials', 'NonSymmetricMacdonaldPolynomials')
 lazy_import('sage.combinat.root_system.integrable_representations', 'IntegrableRepresentation')
 
-# install the docstring of this module to the containing package
-from sage.misc.namespace_package import install_doc
-install_doc(__package__, __doc__)

src/sage/combinat/words/__init__.py

@@ -1 +1,41 @@
+r"""
+Combinatorics on words
 
+**Main modules and their methods:**
+
+- :ref:`sage.combinat.words.abstract_word`
+- :ref:`sage.combinat.words.finite_word`
+- :ref:`sage.combinat.words.infinite_word`
+- :ref:`sage.combinat.words.alphabet`
+- :ref:`sage.combinat.words.words`
+- :ref:`sage.combinat.words.paths`
+- :ref:`sage.combinat.words.morphism`
+- :ref:`sage.combinat.words.shuffle_product`
+- :ref:`sage.combinat.words.suffix_trees`
+
+Main classes and functions meant to be used by the user:
+
+    :func:`~sage.combinat.words.word.Word`,
+    :class:`~sage.combinat.words.words.FiniteWords`,
+    :class:`~sage.combinat.words.words.InfiniteWords`,
+    :func:`~sage.combinat.words.words.Words`,
+    :func:`~sage.combinat.words.alphabet.Alphabet`,
+    :class:`~sage.combinat.words.morphism.WordMorphism`,
+    :class:`~sage.combinat.words.paths.WordPaths`.
+
+A list of common words can be accessed through ``words.<tab>`` and are listed in
+the :ref:`words catalog <sage.combinat.words.word_generators>`.
+
+**Internal representation of words:**
+
+- :ref:`sage.combinat.words.word`
+- :ref:`sage.combinat.words.word_char`
+- :ref:`sage.combinat.words.word_datatypes`
+- :ref:`sage.combinat.words.word_infinite_datatypes`
+
+**Options:**
+
+- :ref:`sage.combinat.words.word_options`
+
+See :func:`~sage.combinat.words.word_options.WordOptions`.
+"""

src/sage/combinat/words/all.py

@@ -1,48 +1,3 @@
-r"""
-Combinatorics on words
-
-**Main modules and their methods:**
-
-- :ref:`sage.combinat.words.abstract_word`
-- :ref:`sage.combinat.words.finite_word`
-- :ref:`sage.combinat.words.infinite_word`
-- :ref:`sage.combinat.words.alphabet`
-- :ref:`sage.combinat.words.words`
-- :ref:`sage.combinat.words.paths`
-- :ref:`sage.combinat.words.morphism`
-- :ref:`sage.combinat.words.shuffle_product`
-- :ref:`sage.combinat.words.suffix_trees`
-
-Main classes and functions meant to be used by the user:
-
-    :func:`~sage.combinat.words.word.Word`,
-    :class:`~sage.combinat.words.words.FiniteWords`,
-    :class:`~sage.combinat.words.words.InfiniteWords`,
-    :func:`~sage.combinat.words.words.Words`,
-    :func:`~sage.combinat.words.alphabet.Alphabet`,
-    :class:`~sage.combinat.words.morphism.WordMorphism`,
-    :class:`~sage.combinat.words.paths.WordPaths`.
-
-A list of common words can be accessed through ``words.<tab>`` and are listed in
-the :ref:`words catalog <sage.combinat.words.word_generators>`.
-
-**Internal representation of words:**
-
-- :ref:`sage.combinat.words.word`
-- :ref:`sage.combinat.words.word_char`
-- :ref:`sage.combinat.words.word_datatypes`
-- :ref:`sage.combinat.words.word_infinite_datatypes`
-
-**Options:**
-
-- :ref:`sage.combinat.words.word_options`
-
-See :func:`~sage.combinat.words.word_options.WordOptions`.
-"""
-# install the docstring of this module to the containing package
-from sage.misc.namespace_package import install_doc
-install_doc(__package__, __doc__)
-
 from .alphabet import Alphabet, build_alphabet
 from .morphism import WordMorphism
 from .paths import WordPaths

src/sage/dynamics/__init__.py

@@ -1,3 +0,0 @@
-r"""
-Flat surfaces
-"""

src/sage/dynamics/all.py

@@ -1,4 +1,6 @@
 """
+Flat surfaces
+
 Some code about flat surfaces and interval exchanges has been removed
 from Sage. The package ``surface_dynamics`` contains all that code
 and much more. For more information, see
@@ -14,6 +16,10 @@
 
     sage -pip install surface_dynamics --user
 """
+# install the docstring of this module to the containing package
+from sage.misc.namespace_package import install_doc
+install_doc(__package__, __doc__)
+
 from sage.misc.lazy_import import lazy_import
 
 from sage.dynamics.arithmetic_dynamics.all import *

src/sage/matroids/all.py

@@ -1,3 +1,10 @@
+"""
+Matroids
+"""
+# install the docstring of this module to the containing package
+from sage.misc.namespace_package import install_doc
+install_doc(__package__, __doc__)
+
 from sage.misc.lazy_import import lazy_import
 # from constructor import Matroid
 # import matroids_catalog as matroids