Rename display_page_number to simple_page_number

docs/source/changelog.rst

@@ -35,9 +35,8 @@ Added
   uncertain quantities.
 - Added `.PageStyle` class to support the creation of various page styles. In
   addition to this class `.Head` and `.Foot` were added for creating unique
-  headers and footers within the page styles.
-- Added a display_page_number method inside `~.Head` to return a string which
-  displays the page number in latex.
+  headers and footers within the page styles. A `.simple_page_number` function
+  was also added for easy displaying of a simple page number.
 - Added a new type of container `.ContainerCommand` for supporting commands
   with data.
 - Added new options to the `.Document` constructor: ``geometry_options`` (a

examples/complex_report.py

@@ -14,7 +14,7 @@
 
 from pylatex import Document, PageStyle, Head, Foot, MiniPage, \
     StandAloneGraphic, MultiColumn, Tabu, LongTabu, LargeText, MediumText, \
-    LineBreak, NewPage, Tabularx, TextColor
+    LineBreak, NewPage, Tabularx, TextColor, simple_page_number
 from pylatex.utils import bold, NoEscape
 
 
@@ -70,7 +70,7 @@ def generate_unique():
                                         pos='t', align='r')
             document_details.append("1000")
             document_details.append(LineBreak())
-            document_details.append(Head.display_page_number())
+            document_details.append(simple_page_number())
 
             footer_table.add_row([branch_address, branch_address,
                                   branch_address, document_details])

examples/header.py

@@ -10,7 +10,7 @@
 
 # begin-doc-include
 from pylatex import Document, PageStyle, Head, MiniPage, Foot, LargeText, \
-    MediumText, LineBreak
+    MediumText, LineBreak, simple_page_number
 from pylatex.utils import bold
 
 
@@ -29,7 +29,7 @@ def generate_header():
         header.append("Company")
     # Create right header
     with header.create(Head("R")):
-        header.append(Head.display_page_number())
+        header.append(simple_page_number())
     # Create left footer
     with header.create(Foot("L")):
         header.append("Left Footer")

pylatex/__init__.py

@@ -21,5 +21,5 @@
 from .base_classes import Command, UnsafeCommand
 from .utils import NoEscape, escape_latex, _latex_item_to_string
 from .errors import TableRowSizeError
-from .headfoot import PageStyle, Head, Foot
+from .headfoot import PageStyle, Head, Foot, simple_page_number
 from .position import Center, FlushLeft, FlushRight, MiniPage, TextBlock

pylatex/headfoot.py

@@ -67,6 +67,18 @@ def change_thickness(self, element, thickness):
                 NoEscape(r"\footrulewidth"), str(thickness) + 'pt']))
 
 
+def simple_page_number():
+    """Get a string containing commands to display the page number.
+
+    Returns
+    -------
+    str
+        The latex string that displays the page number
+    """
+
+    return NoEscape(r'Page \thepage\ of \pageref{LastPage}')
+
+
 class Head(ContainerCommand):
     r"""Allows the creation of headers."""
 
@@ -86,18 +98,6 @@ def __init__(self, position=None, *, data=None):
 
         super().__init__(data=data, options=position)
 
-    @staticmethod
-    def display_page_number():
-        """Get the string that displays the page number.
-
-        Returns
-        -------
-        str
-            The latex string that displays the page number
-        """
-
-        return NoEscape(r'Page \thepage\ of \pageref{LastPage}')
-
 
 class Foot(Head):
     r"""Allows the creation of footers."""