diff --git a/README.rst b/README.rst index 98dc2c4..eea5796 100644 --- a/README.rst +++ b/README.rst @@ -25,12 +25,12 @@ what is missing: resize images, create thumbnails, generate HTML pages. Sigal requires Python 3.8+. -Links : +Links +----- * Latest documentation on the website_ * Source, issues and pull requests on GitHub_ * Releases on PyPI_ -* ``#sigal`` on Freenode, or with the webchat_ interface. Themes & Demo ------------- @@ -51,5 +51,4 @@ Javascript libraries: .. _galleria demo: http://saimon.org/sigal-demo/galleria/ .. _colorbox demo: http://saimon.org/sigal-demo/colorbox/ .. _photoswipe demo: http://saimon.org/sigal-demo/photoswipe/ -.. _webchat: http://webchat.freenode.net/?channels=sigal .. _Jinja2: https://palletsprojects.com/p/jinja/ diff --git a/docs/conf.py b/docs/conf.py index 8a37a98..a184308 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,14 +1,12 @@ -import os -import sys - -import alabaster +# import os +# import sys from sigal import __version__ # 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.append(os.path.abspath("..")) +# sys.path.append(os.path.abspath("..")) # -- General configuration ---------------------------------------------------- @@ -17,7 +15,7 @@ sys.path.append(os.path.abspath("..")) # 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.extlinks", "alabaster"] +extensions = ["sphinx.ext.autodoc", "sphinx.ext.extlinks"] extlinks = {"issue": ("https://github.com/saimn/sigal/issues/%s", "#%s")} @@ -70,6 +68,7 @@ exclude_patterns = ["_build"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" +pygments_dark_style = "monokai" # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] @@ -77,89 +76,25 @@ pygments_style = "sphinx" # -- Options for HTML output -------------------------------------------------- -html_theme_path = [alabaster.get_path()] -html_theme = "alabaster" -html_sidebars = { - "**": [ - "about.html", - "navigation.html", - "searchbox.html", - "donate.html", - ] -} +html_theme = "furo" + html_theme_options = { - # 'logo': 'logo.png', - "github_user": "saimn", - "github_repo": "sigal", - "description": "Yet another simple static gallery generator.", - # 'analytics_id': 'UA-18486793-2', - # 'travis_button': True, + "source_repository": "https://github.com/saimn/sigal/", + "source_branch": "main", + "source_directory": "docs/", + "footer_icons": [ + { + "name": "GitHub", + "url": "https://github.com/saimn/sigal", + "html": """ + + + + """, + "class": "", + }, + ], } -# html_theme_options['extra_nav_links'] = { -# "Main website": 'http://www.paramiko.org', -# } - -# 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'] - -# 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 - -# 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 = "Sigaldoc" diff --git a/docs/faq.rst b/docs/faq.rst index 6e3ed7f..978ebff 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -2,8 +2,6 @@ Frequently Asked Questions (FAQ) ================================== -.. contents:: - How do I protect the gallery with a password? --------------------------------------------- diff --git a/docs/plugins.rst b/docs/plugins.rst index 9d87cf2..ae298df 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -2,8 +2,6 @@ Plugins ========= -.. contents:: - How to use plugins ------------------ diff --git a/pyproject.toml b/pyproject.toml index df3bbbd..20da527 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,7 +38,7 @@ dynamic = ["version"] [project.optional-dependencies] all = ["boto", "brotli", "feedgenerator", "zopfli", "cryptography"] tests = ["pytest", "pytest-cov"] -docs = ["Sphinx>=4.1.0", "alabaster", "cryptography"] +docs = ["Sphinx>=4.1.0", "furo", "cryptography"] [project.scripts] sigal = "sigal.__main__:main"