update package file docs

Author: bygu4

pyformlang/__init__.py

@@ -1,29 +1,32 @@
 """Pyformlang is a python module to perform operation on formal languages.
 
-How to use the documentation
-----------------------------
-Documentation is available in two formats: docstrings directly
-in the code and a readthedocs website: https://pyformlang.readthedocs.io.
+:mod:`pyformlang`
+=================
 
 Available subpackages
 ---------------------
-:mod:`pyformlang.regular_expression`:
+:mod:`~pyformlang.regular_expression`:
     Regular Expressions.
-:mod:`pyformlang.finite_automaton`:
+:mod:`~pyformlang.finite_automaton`:
     Finite Automata (deterministic, non-deterministic,
     with/without epsilon transitions).
-:mod:`pyformlang.fst`:
+:mod:`~pyformlang.fst`:
     Finite State Transducers.
-:mod:`pyformlang.cfg`:
+:mod:`~pyformlang.cfg`:
     Context-Free Grammars.
-:mod:`pyformlang.pda`:
+:mod:`~pyformlang.pda`:
     Push-Down Automata.
-:mod:`pyformlang.indexed_grammar`:
+:mod:`~pyformlang.indexed_grammar`:
     Indexed Grammars.
-:mod:`pyformlang.rsa`:
+:mod:`~pyformlang.rsa`:
     Recursive Automata.
-:mod:`pyformlang.fcfg`:
+:mod:`~pyformlang.fcfg`:
     Context-Free Grammars with Features.
+
+How to use the documentation
+----------------------------
+Documentation is available in two formats: docstrings directly
+in the code and a readthedocs website: https://pyformlang.readthedocs.io.
 """
 
 from . import finite_automaton

pyformlang/cfg/__init__.py

@@ -5,21 +5,21 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.cfg.CFG`:
+:class:`~pyformlang.cfg.CFG`:
     The main context-free grammar class.
-:class:`pyformlang.cfg.Production`:
+:class:`~pyformlang.cfg.Production`:
     A class to represent a production in a CFG.
-:class:`pyformlang.cfg.CFGObject`:
+:class:`~pyformlang.cfg.CFGObject`:
     A general CFG object representation.
-:class:`pyformlang.cfg.Variable`:
+:class:`~pyformlang.cfg.Variable`:
     A variable in context-free grammar.
-:class:`pyformlang.cfg.Terminal`:
+:class:`~pyformlang.cfg.Terminal`:
     A terminal in context-free grammar.
-:class:`pyformlang.cfg.Epsilon`:
+:class:`~pyformlang.cfg.Epsilon`:
     The epsilon symbol (special terminal).
-:class:`pyformlang.cfg.ParseTree`:
+:class:`~pyformlang.cfg.ParseTree`:
     A parse tree of the grammar.
-:class:`pyformlang.cfg.DerivationDoesNotExistError`:
+:class:`~pyformlang.cfg.DerivationDoesNotExistError`:
     An exception that occurs if the given word cannot
     be derived from the grammar.
 """

pyformlang/fcfg/__init__.py

@@ -5,29 +5,29 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.fcfg.FCFG`:
+:class:`~pyformlang.fcfg.FCFG`:
     A context-free grammar with features.
-:class:`pyformlang.fcfg.FeatureStructure`:
+:class:`~pyformlang.fcfg.FeatureStructure`:
     A feature structure containing constraints.
-:class:`pyformlang.fcfg.FeatureProduction`:
+:class:`~pyformlang.fcfg.FeatureProduction`:
     A production in the FCFG.
-:class:`pyformlang.fcfg.CFGObject`:
+:class:`~pyformlang.fcfg.CFGObject`:
     The general CFG object used in FCFG.
-:class:`pyformlang.fcfg.Variable`:
+:class:`~pyformlang.fcfg.Variable`:
     A variable in FCFG.
-:class:`pyformlang.fcfg.Terminal`:
+:class:`~pyformlang.fcfg.Terminal`:
     A terminal in FCFG.
-:class:`pyformlang.fcfg.Epsilon`:
+:class:`~pyformlang.fcfg.Epsilon`:
     The epsilon terminal.
-:class:`pyformlang.fcfg.ParseTree`:
+:class:`~pyformlang.fcfg.ParseTree`:
     A parse tree of the grammar.
-:class:`pyformlang.fcfg.NotParsableError`:
+:class:`~pyformlang.fcfg.NotParsableError`:
     An exception that occurs when the given grammar cannot be parsed.
-:class:`pyformlang.fcfg.ContentAlreadyExistsError`:
+:class:`~pyformlang.fcfg.ContentAlreadyExistsError`:
     An exception raised when trying to add content that already exists.
-:class:`pyformlang.fcfg.FeatureStructuresNotCompatibleError`:
+:class:`~pyformlang.fcfg.FeatureStructuresNotCompatibleError`:
     An exception raised when trying to unify incompatible structures.
-:class:`pyformlang.fcfg.PathDoesNotExistError`:
+:class:`~pyformlang.fcfg.PathDoesNotExistError`:
     An exception raised when looking for a path that does not exist.
 
 Sources

pyformlang/finite_automaton/__init__.py

@@ -5,30 +5,30 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.finite_automaton.FiniteAutomaton`:
+:class:`~pyformlang.finite_automaton.FiniteAutomaton`:
     An abstract class representing the general finite automaton.
-:class:`pyformlang.finite_automaton.EpsilonNFA`:
+:class:`~pyformlang.finite_automaton.EpsilonNFA`:
     A non-deterministic finite automaton with epsilon transitions.
-:class:`pyformlang.finite_automaton.NondeterministicFiniteAutomaton`:
+:class:`~pyformlang.finite_automaton.NondeterministicFiniteAutomaton`:
     A non-deterministic finite automaton without epsilon transitions.
-:class:`pyformlang.finite_automaton.DeterministicFiniteAutomaton`:
+:class:`~pyformlang.finite_automaton.DeterministicFiniteAutomaton`:
     A deterministic finite automaton.
-:class:`pyformlang.finite_automaton.State`:
+:class:`~pyformlang.finite_automaton.State`:
     A state (or node) in an automaton.
-:class:`pyformlang.finite_automaton.Symbol`:
+:class:`~pyformlang.finite_automaton.Symbol`:
     A symbol (part of the alphabet) in an automaton.
-:class:`pyformlang.finite_automaton.Epsilon`:
+:class:`~pyformlang.finite_automaton.Epsilon`:
     The epsilon (or empty) symbol.
-:class:`pyformlang.finite_automaton.TransitionFunction`:
+:class:`~pyformlang.finite_automaton.TransitionFunction`:
     An interface representing the transition function in a finite automaton.
-:class:`pyformlang.finite_automaton.NondeterministicTransitionFunction`:
+:class:`~pyformlang.finite_automaton.NondeterministicTransitionFunction`:
     A non-deterministic transition function.
-:class:`pyformlang.finite_automaton.DeterministicTransitionFunction`:
+:class:`~pyformlang.finite_automaton.DeterministicTransitionFunction`:
     A deterministic transition function.
-:class:`pyformlang.finite_automaton.DuplicateTransitionError`:
+:class:`~pyformlang.finite_automaton.DuplicateTransitionError`:
     An error that occurs when trying to add a non-deterministic edge to a
     deterministic automaton.
-:class:`pyformlang.finite_automaton.InvalidEpsilonTransitionError`:
+:class:`~pyformlang.finite_automaton.InvalidEpsilonTransitionError`:
     An exception that occurs when adding an epsilon transition to a
     non-epsilon NFA.
 """

pyformlang/fst/__init__.py

@@ -5,15 +5,15 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.fst.FST`:
+:class:`~pyformlang.fst.FST`:
     A Finite State Transducer.
-:class:`pyformlang.fst.TransitionFunction`:
+:class:`~pyformlang.fst.TransitionFunction`:
     A transition function in FST.
-:class:`pyformlang.fst.State`:
+:class:`~pyformlang.fst.State`:
     A state in FST.
-:class:`pyformlang.fst.Symbol`:
+:class:`~pyformlang.fst.Symbol`:
     A symbol in FST.
-:class:`pyformlang.fst.Epsilon`:
+:class:`~pyformlang.fst.Epsilon`:
     An epsilon symbol.
 """
 

pyformlang/indexed_grammar/__init__.py

@@ -5,27 +5,27 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.indexed_grammar.IndexedGrammar`:
+:class:`~pyformlang.indexed_grammar.IndexedGrammar`:
     An indexed grammar.
-:class:`pyformlang.indexed_grammar.Rules`:
+:class:`~pyformlang.indexed_grammar.Rules`:
     A representation of a set of indexed grammar rules.
-:class:`pyformlang.indexed_grammar.ReducedRule`:
+:class:`~pyformlang.indexed_grammar.ReducedRule`:
     An indexed grammar rule of any of possible forms.
-:class:`pyformlang.indexed_grammar.ConsumptionRule`:
+:class:`~pyformlang.indexed_grammar.ConsumptionRule`:
     A consumption rule, consuming something from the stack.
-:class:`pyformlang.indexed_grammar.EndRule`:
+:class:`~pyformlang.indexed_grammar.EndRule`:
     An end rule, turning a variable into a terminal.
-:class:`pyformlang.indexed_grammar.ProductionRule`:
+:class:`~pyformlang.indexed_grammar.ProductionRule`:
     A production rule, pushing something on the stack.
-:class:`pyformlang.indexed_grammar.DuplicationRule`:
+:class:`~pyformlang.indexed_grammar.DuplicationRule`:
     A duplication rule, duplicating the stack.
-:class:`pyformlang.indexed_grammar.CFGObject`:
+:class:`~pyformlang.indexed_grammar.CFGObject`:
     A general CFG object used in indexed grammars.
-:class:`pyformlang.indexed_grammar.Variable`:
+:class:`~pyformlang.indexed_grammar.Variable`:
     A variable in indexed grammars.
-:class:`pyformlang.indexed_grammar.Terminal`:
+:class:`~pyformlang.indexed_grammar.Terminal`:
     A terminal in indexed grammars.
-:class:`pyformlang.indexed_grammar.Epsilon`:
+:class:`~pyformlang.indexed_grammar.Epsilon`:
     An epsilon terminal.
 """
 

pyformlang/pda/__init__.py

@@ -5,17 +5,17 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.pda.PDA`:
+:class:`~pyformlang.pda.PDA`:
     A push-down automaton.
-:class:`pyformlang.pda.TransitionFunction`:
+:class:`~pyformlang.pda.TransitionFunction`:
     A transition function in push-down automaton.
-:class:`pyformlang.pda.State`:
+:class:`~pyformlang.pda.State`:
     A state in push-down automaton.
-:class:`pyformlang.pda.Symbol`:
+:class:`~pyformlang.pda.Symbol`:
     A symbol in push-down automaton.
-:class:`pyformlang.pda.StackSymbol`:
+:class:`~pyformlang.pda.StackSymbol`:
     A stack symbol in push-down automaton.
-:class:`pyformlang.pda.Epsilon`:
+:class:`~pyformlang.pda.Epsilon`:
     The epsilon symbol.
 """
 

pyformlang/regular_expression/__init__.py

@@ -8,11 +8,11 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.regular_expression.Regex`:
+:class:`~pyformlang.regular_expression.Regex`:
     A regular expression.
-:class:`pyformlang.regular_expression.PythonRegex`:
+:class:`~pyformlang.regular_expression.PythonRegex`:
     A regular expression closer to Python format.
-:class:`pyformlang.regular_expression.MisformedRegexError`:
+:class:`~pyformlang.regular_expression.MisformedRegexError`:
     An error occurring when the input regex is incorrect.
 """
 

pyformlang/rsa/__init__.py

@@ -5,11 +5,11 @@
 
 Available Classes
 -----------------
-:class:`pyformlang.rsa.RecursiveAutomaton`:
+:class:`~pyformlang.rsa.RecursiveAutomaton`:
     A recursive automaton.
-:class:`pyformlang.rsa.Box`:
+:class:`~pyformlang.rsa.Box`:
     A constituent part of a recursive automaton.
-:class:`pyformlang.rsa.Symbol`:
+:class:`~pyformlang.rsa.Symbol`:
     A nonterminal of the Box.
 
 References