From 49ead8f436698efaf94b0da95eedf7c849c0842d Mon Sep 17 00:00:00 2001 From: Christian Ledermann Date: Thu, 28 Nov 2024 15:02:38 +0000 Subject: [PATCH] update documentation --- docs/conf.py | 276 +++++--------------------------------- docs/create_kml_files.rst | 11 +- docs/fastkml.rst | 9 +- fastkml/registry.py | 21 +-- 4 files changed, 50 insertions(+), 267 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 53caa139..07251bbd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,33 +1,36 @@ +# noqa: INP001, D100 +# Configuration file for the Sphinx documentation builder. # -# FastKML documentation build configuration file, created by -# sphinx-quickstart on Mon Oct 13 22:24:07 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -import os +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +import pathlib import sys +DOC_ROOT = pathlib.Path(__file__).parent +PROJECT_ROOT = DOC_ROOT.parent + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) -from fastkml import about +sys.path.insert(0, str(PROJECT_ROOT)) +from fastkml import about # noqa: E402 -# -- General configuration ------------------------------------------------ +# General information about the project. +project = "FastKML" +copyright = "2014 -2024, Christian Ledermann & Ian Lee" # noqa: A001 +author = "Christian Ledermann" +# The short X.Y version. +version = ".".join(about.__version__.split(".")[:2]) +# The full version, including alpha/beta/rc tags. +release = about.__version__ -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ "sphinx.ext.autodoc", "sphinx.ext.doctest", @@ -38,75 +41,21 @@ ] autosummary_generate = True -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix of source filenames. -source_suffix = ".rst" - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" -# General information about the project. -project = "FastKML" -copyright = "2014 -2024, Christian Ledermann & Ian Lee" - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = ".".join(about.__version__.split(".")[:2]) -# The full version, including alpha/beta/rc tags. -release = about.__version__ - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True +root_doc = "index" -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "default" +html_theme = "alabaster" +html_static_path = ["_static"] try: import sphinx_rtd_theme @@ -115,67 +64,6 @@ except ImportError: pass -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - html_context = { "display_github": True, # Integrate GitHub "github_user": "cleder", # Username @@ -183,107 +71,3 @@ "github_version": "main", # Version "conf_py_path": "/docs/", # Path in the checkout to the docs root } - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = "FastKMLdoc" - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - "index", - "FastKML.tex", - "FastKML Documentation", - r"Christian Ledermann \& Ian Lee", - "manual", - ), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ("index", "fastkml", "FastKML Documentation", ["Christian Ledermann & Ian Lee"], 1), -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - "index", - "FastKML", - "FastKML Documentation", - "Christian Ledermann & Ian Lee", - "FastKML", - "One line description of project.", - "Miscellaneous", - ), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False diff --git a/docs/create_kml_files.rst b/docs/create_kml_files.rst index f722aa20..d608a0ee 100644 --- a/docs/create_kml_files.rst +++ b/docs/create_kml_files.rst @@ -109,10 +109,8 @@ Finally, we create the KML object and write it to a file: >>> document = fastkml.containers.Document(features=placemarks) >>> kml = fastkml.KML(features=[document]) >>> outfile = pathlib.Path("co2_per_capita_2020.kml") - >>> with outfile.open("w") as f: - ... f.write(kml.to_string(prettyprint=True, precision=3)) # doctest: +ELLIPSIS - ... - 4... + >>> kml.write(outfile, prettyprint=True, precision=3) # doctest: +ELLIPSIS + The resulting KML file can be opened in Google Earth or any other KML viewer. @@ -232,10 +230,7 @@ Finally, we create the KML object and write it to a file: >>> document = fastkml.containers.Document(features=folders, styles=styles) >>> kml = fastkml.KML(features=[document]) >>> outfile = pathlib.Path("co2_growth_1995_2022.kml") - >>> with outfile.open("w") as f: - ... f.write(kml.to_string(prettyprint=True, precision=3)) # doctest: +ELLIPSIS - ... - 1... + >>> kml.write(outfile, prettyprint=True, precision=3) You can open the resulting KML file in Google Earth Desktop and use the time slider to diff --git a/docs/fastkml.rst b/docs/fastkml.rst index 96553566..86e54762 100644 --- a/docs/fastkml.rst +++ b/docs/fastkml.rst @@ -30,14 +30,13 @@ fastkml.registry ----------------------- .. automodule:: fastkml.registry - :members: + :members: RegistryItem,Registry :undoc-members: :show-inheritance: -.. autoclass:: fastkml.registry::Registry - :members: register, get - :undoc-members: - :show-inheritance: + .. autodata:: registry + :no-value: + fastkml.kml\_base ------------------------ diff --git a/fastkml/registry.py b/fastkml/registry.py index 76023093..d603a80b 100644 --- a/fastkml/registry.py +++ b/fastkml/registry.py @@ -20,14 +20,6 @@ This approach allows for flexible, declarative mapping between XML and Python objects, with the registry acting as a central configuration for these mappings. -Direct ``Registry`` class use is typically only for library internals or advanced -customization. For normal usage, stick with the ``registry`` instance: - -- The library is designed around this global instance. -- Ensures all parts of the library use the same registry. -- Pre-populated with standard KML mappings. -- Singleton pattern: Avoids multiple conflicting registries. - """ from dataclasses import dataclass @@ -188,5 +180,18 @@ def get(self, cls: Type["_XMLObject"]) -> List[RegistryItem]: registry = Registry() +""" +Global Registry. + +You should use ``registry.registry`` instead of instantiating ``registry.Registry()`` +because ``registry.registry`` is a pre-instantiated global instance, ensuring a single, +shared registry across the entire application. +It is pre-populated with all the necessary KML element registrations. +If you need to add custom elements, you can extend the existing registry without +creating a new one. +Using the pre-defined ``registry.registry`` ensures you're working with the complete, +properly initialized registry for the fastkml library. + +""" __all__ = ["RegistryItem", "registry"]