# HG changeset patch # User RhodeCode Admin # Date 2023-11-17 09:46:07 # Node ID 1e179e1f5e44791cd9c8b52944db7e136ee52589 # Parent 2a29ebefcba68ced5039d2256b5a843e1de979ba feat(docs): new docs build logic - remove nix - use docker container - install latest google analytics diff --git a/Makefile b/Makefile --- a/Makefile +++ b/Makefile @@ -69,19 +69,19 @@ ruff-check: .PHONY: docs ## build docs docs: - (cd docs; nix-build default.nix -o result; make clean html) + (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html) .PHONY: docs-clean ## Cleanup docs docs-clean: - (cd docs; make clean) + (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean) .PHONY: docs-cleanup ## Cleanup docs docs-cleanup: - (cd docs; make cleanup) + (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make cleanup) .PHONY: web-build diff --git a/docs/.howto b/docs/.howto --- a/docs/.howto +++ b/docs/.howto @@ -1,9 +1,6 @@ -# generating packages -nix-shell pkgs/shell-generate.nix -cd docs -pip2nix generate +## BUILD +# cd docs +# docker build --tag sphinx-doc-build-rc . -# building the docs -cd docs -nix-build default.nix -o result -make clean html +# Build Docs +# docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html \ No newline at end of file diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,5 @@ +FROM sphinxdoc/sphinx + +WORKDIR /project +ADD requirements_docs.txt /project +RUN pip3 install -r requirements_docs.txt diff --git a/docs/Makefile b/docs/Makefile --- a/docs/Makefile +++ b/docs/Makefile @@ -2,9 +2,9 @@ # # You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = ./result/bin/sphinx-build -PAPER = +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source BUILDDIR = _build # User-friendly check for sphinx-build diff --git a/docs/_templates/base.html b/docs/_templates/base.html new file mode 100644 --- /dev/null +++ b/docs/_templates/base.html @@ -0,0 +1,117 @@ + + + + + + + + {%- block site_meta -%} + + + + + {%- if metatags %}{{ metatags }}{% endif -%} + + {%- block linktags %} + {%- if hasdoc('about') -%} + + {%- endif -%} + {%- if hasdoc('genindex') -%} + + {%- endif -%} + {%- if hasdoc('search') -%} + + {%- endif -%} + {%- if hasdoc('copyright') -%} + + {%- endif -%} + {%- if next -%} + + {%- endif -%} + {%- if prev -%} + + {%- endif -%} + {#- rel="canonical" (set by html_baseurl) -#} + {%- if pageurl %} + + {%- endif %} + {%- endblock linktags %} + + {# Favicon #} + {%- if favicon_url -%} + + {%- endif -%} + + + + {%- endblock site_meta -%} + + {#- Site title -#} + {%- block htmltitle -%} + {% if not docstitle %} + {{ title|striptags|e }} + {% elif pagename == master_doc %} + {{ docstitle|striptags|e }} + {% else %} + {{ title|striptags|e }} - {{ docstitle|striptags|e }} + {% endif %} + {%- endblock -%} + + {%- block styles -%} + + {# Custom stylesheets #} + {%- block regular_styles -%} + {%- for css in css_files -%} + {% if css|attr("filename") -%} + {{ css_tag(css) }} + {%- else -%} + + {%- endif %} + {% endfor -%} + {%- endblock regular_styles -%} + + {#- Theme-related stylesheets -#} + {%- block theme_styles %} + {% include "partials/_head_css_variables.html" with context %} + {%- endblock -%} + + {%- block extra_styles %} + {%- endblock -%} + + {%- endblock styles -%} + + {#- Custom front matter #} + {%- block extrahead -%}{%- endblock -%} + + + + + + + {% block body %} + + {% endblock %} + + {%- block scripts -%} + + {# Custom JS #} + {%- block regular_scripts -%} + {% for path in script_files -%} + {{ js_tag(path) }} + {% endfor -%} + {%- endblock regular_scripts -%} + + {# Theme-related JavaScript code #} + {%- block theme_scripts -%} + {%- endblock -%} + + {%- endblock scripts -%} + + \ No newline at end of file diff --git a/docs/_templates/footer.html b/docs/_templates/footer.html deleted file mode 100644 --- a/docs/_templates/footer.html +++ /dev/null @@ -1,6 +0,0 @@ -{% extends "!footer.html" %} - -{% block extrafooter %} -
-Documentation defects and suggestions can be submitted here -{% endblock %} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html deleted file mode 100644 --- a/docs/_templates/layout.html +++ /dev/null @@ -1,18 +0,0 @@ -{% extends "!layout.html" %} -{% set css_files = css_files + ['_static/add.css'] %} - -{% block footer %} -{{ super() }} - - - -{% endblock %} diff --git a/docs/_templates/page.html b/docs/_templates/page.html new file mode 100644 --- /dev/null +++ b/docs/_templates/page.html @@ -0,0 +1,204 @@ +{% extends "base.html" %} + +{% block body -%} +{{ super() }} +{% include "partials/icons.html" %} + + + + + + + + +{% if theme_announcement -%} +

+ +

+{%- endif %} + +

+ + +

+ + + {% trans %}Back to top{% endtrans %} + +

+ {% if theme_top_of_page_button == "edit" -%} + {%- include "components/edit-this-page.html" with context -%} + {%- elif theme_top_of_page_button != None -%} + {{ warning("Got an unsupported value for 'top_of_page_button'") }} + {%- endif -%} + {#- Theme toggle -#} +

+ +

+ + + + +

+ {% block content %}{{ body }}{% endblock %} +

+ +

+ +{%- endblock %} diff --git a/docs/admin/system_admin/reset-information.rst b/docs/admin/system_admin/reset-information.rst --- a/docs/admin/system_admin/reset-information.rst +++ b/docs/admin/system_admin/reset-information.rst @@ -25,7 +25,7 @@ account permissions. # Open iShell from the terminal $ rccontrol ishell enterprise-1 -.. code-block:: mysql +.. code-block:: python # Use this example to change user permissions In [1]: adminuser = User.get_by_username('username') @@ -49,7 +49,7 @@ following example to make changes to thi # Open iShell from the terminal $ rccontrol ishell enterprise-1 -.. code-block:: mysql +.. code-block:: python # Use this example to enable global .hgrc access In [1]: new_option = RhodeCodeUi() @@ -76,7 +76,7 @@ Use the following code example to carry # starts the ishell interactive prompt $ rccontrol ishell enterprise-1 -.. code-block:: mysql +.. code-block:: python In [1]: from rhodecode.lib.auth import generate_auth_token In [2]: from rhodecode.lib.auth import get_crypt_password @@ -107,7 +107,7 @@ Use the following code example to carry # starts the ishell interactive prompt $ rccontrol ishell enterprise-1 -.. code-block:: mysql +.. code-block:: python # Use this example to change email and username of LDAP user In [1]: my_user = User.get_by_username('some_username') @@ -139,7 +139,7 @@ Use the text which is shown after '#' si # starts the ishell interactive prompt $ rccontrol ishell enterprise-1 -.. code-block:: mysql +.. code-block:: python # Use this example to change users from authentication # using rhodecode internal to ldap diff --git a/docs/api/api.rst b/docs/api/api.rst --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -202,7 +202,6 @@ are not required in args. methods/deprecated-methods methods/gist-methods methods/pull-request-methods - methods/repo-methods methods/repo-group-methods methods/search-methods methods/server-methods diff --git a/docs/common.py b/docs/common.py deleted file mode 100644 --- a/docs/common.py +++ /dev/null @@ -1,32 +0,0 @@ -# Try and keep this list alphabetical -# ui is for user interface elements and messages -# button - that's obvious - -rst_epilog = ''' -.. |AE| replace:: Appenlight -.. |authtoken| replace:: Authentication Token -.. |authtokens| replace:: **Auth Tokens** -.. |RCCEshort| replace:: Community -.. |RCEEshort| replace:: Enterprise -.. |git| replace:: Git -.. |hg| replace:: Mercurial -.. |svn| replace:: Subversion -.. |LDAP| replace:: LDAP / Active Directory -.. |os| replace:: operating system -.. |OS| replace:: Operating System -.. |PY| replace:: Python -.. |pr| replace:: pull request -.. |prs| replace:: pull requests -.. |psf| replace:: Python Software Foundation -.. |repo| replace:: repository -.. |repos| replace:: repositories -.. |RCC| replace:: RhodeCode Control -.. |RCE| replace:: RhodeCode Enterprise -.. |RCCE| replace:: RhodeCode Community -.. |RCEE| replace:: RhodeCode Enterprise -.. |RCX| replace:: RhodeCode Extensions -.. |RCT| replace:: RhodeCode Tools -.. |RCEBOLD| replace:: **RhodeCode Enterprise** -.. |RCEITALICS| replace:: `RhodeCode Enterprise` -.. |RNS| replace:: Release Notes -''' diff --git a/docs/conf.py b/docs/conf.py --- a/docs/conf.py +++ b/docs/conf.py @@ -1,132 +1,160 @@ - -# -# RhodeCode Enterprise documentation build configuration file, created by -# sphinx-quickstart on Tue Nov 4 11:48:37 2014. -# -# This file is execfile()d with the current directory set to its -# containing dir. +# Configuration file for the Sphinx documentation builder. # -# 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 + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information +import os import sys -import os import datetime -import sphinx_rtd_theme + +# sphinx injects tags magically during build, we re-define it here to make linters happy +tags = tags # noqa # 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('.')) -import common +sys.path.insert(0, os.path.abspath(".")) + + +def _get_version(): + with open("../rhodecode/VERSION") as f: + return f.read().strip() + + +now = datetime.datetime.today() + +# The full project version, used as the replacement for |release| and e.g. in the HTML templates. +# For example, for the Python documentation, this may be something like 2.6.0rc1. +# If you don’t need the separation provided between version and release, just set them both to the same value. +release = _get_version() + +# The major project version, used as the replacement for |version|. +# For example, for the Python documentation, this may be something like 2.6. +version = ".".join(release.split(".", 2)[:2]) # First two parts of release + + +# General information about the project. +project = "RhodeCode Enterprise" +copyright = f"2010-{now.year}, RhodeCode GmbH" +author = "RhodeCode GmbH" # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # 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.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.imgmath' + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.imgmath", ] intersphinx_mapping = { - 'enterprise': ('https://docs.rhodecode.com/RhodeCode-Enterprise/', None), - 'control': ('https://docs.rhodecode.com/RhodeCode-Control/', None), + "enterprise": ("https://docs.rhodecode.com/RhodeCode-Enterprise/", None), + "rcstack": ("https://docs.rhodecode.com/rcstack/", None), + "control": ("https://docs.rhodecode.com/RhodeCode-Control/", None), } # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # 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. -def _get_version(): - with open('../rhodecode/VERSION') as f: - return f.read().strip() - - -# The full version, including alpha/beta/rc tags. -release = _get_version() -# The short X.Y version. -version = '.'.join(release.split('.', 2)[:2]) # First two parts of release - -# General information about the project. -project = u'RhodeCode Enterprise %s ' % _get_version() -copyright = u'2010-{now.year}, RhodeCode GmbH'.format( - now=datetime.datetime.today()) - - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None -rst_epilog = common.rst_epilog + """ +rst_epilog = """ .. |async| replace:: asynchronous +.. |AE| replace:: Appenlight +.. |authtoken| replace:: Authentication Token +.. |authtokens| replace:: **Auth Tokens** +.. |RCCEshort| replace:: Community +.. |RCEEshort| replace:: Enterprise +.. |git| replace:: Git +.. |hg| replace:: Mercurial +.. |svn| replace:: Subversion +.. |LDAP| replace:: LDAP / Active Directory +.. |os| replace:: operating system +.. |OS| replace:: Operating System +.. |PY| replace:: Python +.. |pr| replace:: pull request +.. |prs| replace:: pull requests +.. |psf| replace:: Python Software Foundation +.. |repo| replace:: repository +.. |repos| replace:: repositories +.. |RCC| replace:: RhodeCode Control +.. |RCE| replace:: RhodeCode Enterprise +.. |RCCE| replace:: RhodeCode Community +.. |RCEE| replace:: RhodeCode Enterprise +.. |RCX| replace:: RhodeCode Extensions +.. |RCT| replace:: RhodeCode Tools +.. |RCEBOLD| replace:: **RhodeCode Enterprise** +.. |RCEITALICS| replace:: `RhodeCode Enterprise` +.. |RNS| replace:: Release Notes """ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# 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 = [ # Special directories - '_build', - 'result', - + "_build", + "result", # Other RST files - 'admin/rhodecode-backup.rst', - 'issue-trackers/redmine.rst', - 'known-issues/error-msg-guide.rst', - 'tutorials/docs-build.rst', - 'integrations/example-ext.py', - 'collaboration/supported-workflows.rst', + "admin/rhodecode-backup.rst", + "issue-trackers/redmine.rst", + "known-issues/error-msg-guide.rst", + "tutorials/docs-build.rst", + "integrations/example-ext.py", + "collaboration/supported-workflows.rst", ] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. keep_warnings = tags.has("dev") @@ -136,135 +164,138 @@ keep_warnings = tags.has("dev") # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -#html_theme = 'rctheme' -html_theme = 'sphinx_rtd_theme' +html_theme = "furo" # 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 = {} -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +# html_theme_options = {} + # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# 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 -html_sidebars = { - '**': ['globaltoc.html'], -} +# html_logo = None + + +#html_sidebars = { +# "**": ["globaltoc.html"], +#} # 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 = 'images/favicon.ico' +html_favicon = "images/favicon.ico" # 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/css/add.css'] +html_static_path = ["static/css/add.css"] # 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 = [] +# 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' +html_last_updated_fmt = " %H:%m %b %d, %Y" # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = 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 = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'rhodecode-enterprise' +htmlhelp_basename = "rhodecode-enterprise" # -- Options for LaTeX output --------------------------------------------- latex_elements = { - 'classoptions': ',oneside', - 'babel': '\\usepackage[english]{babel}', - -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', + "classoptions": ",oneside", + "babel": "\\usepackage[english]{babel}", + # 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', 'RhodeCodeEnterprise.tex', u'RhodeCode Enterprise', - u'RhodeCode GmbH', 'manual'), + ( + "index", + "RhodeCodeEnterprise.tex", + "RhodeCode Enterprise", + "RhodeCode GmbH", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. latex_show_pagerefs = True # If true, show URL addresses after external links. -latex_show_urls = 'footnote' +latex_show_urls = "footnote" # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # Mode for literal blocks wider than the frame. Can be # overflow, shrink or truncate @@ -276,12 +307,11 @@ pdf_fit_mode = "truncate" # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'rhodecodeenterprise', u'RhodeCode Enterprise', - [u'RhodeCode GmbH'], 1) + ("index", "rhodecodeenterprise", "RhodeCode Enterprise", ["RhodeCode GmbH"], 1) ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -290,22 +320,28 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'RhodeCodeEnterprise', u'RhodeCode Enterprise', - u'RhodeCode Docs Team', 'RhodeCodeEnterprise', 'RhodeCode Docs Project', - 'Miscellaneous'), + ( + "index", + "RhodeCodeEnterprise", + "RhodeCode Enterprise", + "RhodeCode Docs Team", + "RhodeCodeEnterprise", + "RhodeCode Docs Project", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False # We want to see todo notes in case of a pre-release build of the documentation todo_include_todos = tags.has("dev") diff --git a/docs/default.nix b/docs/default.nix deleted file mode 100644 --- a/docs/default.nix +++ /dev/null @@ -1,227 +0,0 @@ -{ system ? builtins.currentSystem -}: - -let - - pkgs = import { inherit system; }; - - inherit (pkgs) fetchurl; - - buildPythonPackage = pkgs.python27Packages.buildPythonPackage; - python = pkgs.python27Packages.python; - - - alabaster = buildPythonPackage { - name = "alabaster-0.7.11"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/3f/46/9346ea429931d80244ab7f11c4fce83671df0b7ae5a60247a2b588592c46/alabaster-0.7.11.tar.gz"; - sha256 = "1mvm69xsn5xf1jc45kdq1mn0yq0pfn54mv2jcww4s1vwqx6iyfxn"; - }; - }; - babel = buildPythonPackage { - name = "babel-2.6.0"; - doCheck = false; - propagatedBuildInputs = [ - pytz - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/be/cc/9c981b249a455fa0c76338966325fc70b7265521bad641bf2932f77712f4/Babel-2.6.0.tar.gz"; - sha256 = "08rxmbx2s4irp0w0gmn498vns5xy0fagm0fg33xa772jiks51flc"; - }; - }; - certifi = buildPythonPackage { - name = "certifi-2018.8.24"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/e1/0f/f8d5e939184547b3bdc6128551b831a62832713aa98c2ccdf8c47ecc7f17/certifi-2018.8.24.tar.gz"; - sha256 = "0f0nhrj9mlrf79iway4578wrsgmjh0fmacl9zv8zjckdy7b90rip"; - }; - }; - chardet = buildPythonPackage { - name = "chardet-3.0.4"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/fc/bb/a5768c230f9ddb03acc9ef3f0d4a3cf93462473795d18e9535498c8f929d/chardet-3.0.4.tar.gz"; - sha256 = "1bpalpia6r5x1kknbk11p1fzph56fmmnp405ds8icksd3knr5aw4"; - }; - }; - docutils = buildPythonPackage { - name = "docutils-0.14"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/84/f4/5771e41fdf52aabebbadecc9381d11dea0fa34e4759b4071244fa094804c/docutils-0.14.tar.gz"; - sha256 = "0x22fs3pdmr42kvz6c654756wja305qv6cx1zbhwlagvxgr4xrji"; - }; - }; - idna = buildPythonPackage { - name = "idna-2.7"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/65/c4/80f97e9c9628f3cac9b98bfca0402ede54e0563b56482e3e6e45c43c4935/idna-2.7.tar.gz"; - sha256 = "05jam7d31767dr12x0rbvvs8lxnpb1mhdb2zdlfxgh83z6k3hjk8"; - }; - }; - imagesize = buildPythonPackage { - name = "imagesize-1.1.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/41/f5/3cf63735d54aa9974e544aa25858d8f9670ac5b4da51020bbfc6aaade741/imagesize-1.1.0.tar.gz"; - sha256 = "1dg3wn7qpwmhgqc0r9na2ding1wif9q5spz3j9zn2riwphc2k0zk"; - }; - }; - jinja2 = buildPythonPackage { - name = "jinja2-2.9.6"; - doCheck = false; - propagatedBuildInputs = [ - markupsafe - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/90/61/f820ff0076a2599dd39406dcb858ecb239438c02ce706c8e91131ab9c7f1/Jinja2-2.9.6.tar.gz"; - sha256 = "1zzrkywhziqffrzks14kzixz7nd4yh2vc0fb04a68vfd2ai03anx"; - }; - }; - markupsafe = buildPythonPackage { - name = "markupsafe-1.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/4d/de/32d741db316d8fdb7680822dd37001ef7a448255de9699ab4bfcbdf4172b/MarkupSafe-1.0.tar.gz"; - sha256 = "0rdn1s8x9ni7ss8rfiacj7x1085lx8mh2zdwqslnw8xc3l4nkgm6"; - }; - }; - packaging = buildPythonPackage { - name = "packaging-17.1"; - doCheck = false; - propagatedBuildInputs = [ - pyparsing - six - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/77/32/439f47be99809c12ef2da8b60a2c47987786d2c6c9205549dd6ef95df8bd/packaging-17.1.tar.gz"; - sha256 = "0nrpayk8kij1zm9sjnk38ldz3a6705ggvw8ljylqbrb4vmqbf6gh"; - }; - }; - pygments = buildPythonPackage { - name = "pygments-2.2.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/71/2a/2e4e77803a8bd6408a2903340ac498cb0a2181811af7c9ec92cb70b0308a/Pygments-2.2.0.tar.gz"; - sha256 = "1k78qdvir1yb1c634nkv6rbga8wv4289xarghmsbbvzhvr311bnv"; - }; - }; - pyparsing = buildPythonPackage { - name = "pyparsing-2.2.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/3c/ec/a94f8cf7274ea60b5413df054f82a8980523efd712ec55a59e7c3357cf7c/pyparsing-2.2.0.tar.gz"; - sha256 = "016b9gh606aa44sq92jslm89bg874ia0yyiyb643fa6dgbsbqch8"; - }; - }; - pytz = buildPythonPackage { - name = "pytz-2018.4"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/10/76/52efda4ef98e7544321fd8d5d512e11739c1df18b0649551aeccfb1c8376/pytz-2018.4.tar.gz"; - sha256 = "0jgpqx3kk2rhv81j1izjxvmx8d0x7hzs1857pgqnixic5wq2ar60"; - }; - }; - requests = buildPythonPackage { - name = "requests-2.19.1"; - doCheck = false; - propagatedBuildInputs = [ - chardet - idna - urllib3 - certifi - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/54/1f/782a5734931ddf2e1494e4cd615a51ff98e1879cbe9eecbdfeaf09aa75e9/requests-2.19.1.tar.gz"; - sha256 = "0snf8xxdzsgh1x2zv3vilvbrv9jbpmnfagzzb1rjmmvflckdh8pc"; - }; - }; - six = buildPythonPackage { - name = "six-1.11.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/16/d8/bc6316cf98419719bd59c91742194c111b6f2e85abac88e496adefaf7afe/six-1.11.0.tar.gz"; - sha256 = "1scqzwc51c875z23phj48gircqjgnn3af8zy2izjwmnlxrxsgs3h"; - }; - }; - snowballstemmer = buildPythonPackage { - name = "snowballstemmer-1.2.1"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/20/6b/d2a7cb176d4d664d94a6debf52cd8dbae1f7203c8e42426daa077051d59c/snowballstemmer-1.2.1.tar.gz"; - sha256 = "0a0idq4y5frv7qsg2x62jd7rd272749xk4x99misf5rcifk2d7wi"; - }; - }; - sphinx = buildPythonPackage { - name = "sphinx-1.7.8"; - doCheck = false; - propagatedBuildInputs = [ - six - jinja2 - pygments - docutils - snowballstemmer - babel - alabaster - imagesize - requests - setuptools - packaging - sphinxcontrib-websupport - typing - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/ac/54/4ef326d0c654da1ed91341a7a1f43efc18a8c770ddd2b8e45df97cb79d82/Sphinx-1.7.8.tar.gz"; - sha256 = "1ryz0w4c31930f1br2sjwrxwx9cmsy7cqdb0d81g98n9bj250w50"; - }; - }; - sphinx-rtd-theme = buildPythonPackage { - name = "sphinx-rtd-theme-0.4.1"; - doCheck = false; - propagatedBuildInputs = [ - sphinx - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/f2/b0/a1933d792b806118ddbca6699f2e2c844d9b1b16e84a89d7effd5cd2a800/sphinx_rtd_theme-0.4.1.tar.gz"; - sha256 = "1xkyqam8dzbjaymdyvkiif85m4y3jf8crdiwlgcfp8gqcj57aj9v"; - }; - }; - sphinxcontrib-websupport = buildPythonPackage { - name = "sphinxcontrib-websupport-1.1.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/07/7a/e74b06dce85555ffee33e1d6b7381314169ebf7e31b62c18fcb2815626b7/sphinxcontrib-websupport-1.1.0.tar.gz"; - sha256 = "1ff3ix76xi1y6m99qxhaq5161ix9swwzydilvdya07mgbcvpzr4x"; - }; - }; - typing = buildPythonPackage { - name = "typing-3.6.6"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/bf/9b/2bf84e841575b633d8d91ad923e198a415e3901f228715524689495b4317/typing-3.6.6.tar.gz"; - sha256 = "0ba9acs4awx15bf9v3nrs781msbd2nx826906nj6fqks2bvca9s0"; - }; - }; - "urllib3" = super.buildPythonPackage { - name = "urllib3-1.25.2"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/9a/8b/ea6d2beb2da6e331e9857d0a60b79ed4f72dcbc4e2c7f2d2521b0480fda2/urllib3-1.25.2.tar.gz"; - sha256 = "1nq2k4pss1ihsjh02r41sqpjpm5rfqkjfysyq7g7n2i1p7c66c55"; - }; - }; - - # Avoid that setuptools is replaced, this leads to trouble - # with buildPythonPackage. - setuptools = pkgs.python27Packages.setuptools; - -in python.buildEnv.override { - inherit python; - extraLibs = [ - sphinx - sphinx-rtd-theme - ]; -} \ No newline at end of file diff --git a/docs/pip2nix.ini b/docs/pip2nix.ini deleted file mode 100644 --- a/docs/pip2nix.ini +++ /dev/null @@ -1,3 +0,0 @@ -[pip2nix] -requirements = -r ./requirements_docs.txt -output = ./python-packages-generated.nix diff --git a/docs/python-packages-generated.nix b/docs/python-packages-generated.nix deleted file mode 100644 --- a/docs/python-packages-generated.nix +++ /dev/null @@ -1,221 +0,0 @@ -# Generated by pip2nix 0.8.0.dev1 -# See https://github.com/johbo/pip2nix - -{ pkgs, fetchurl, fetchgit, fetchhg }: - -self: super: { - "alabaster" = super.buildPythonPackage { - name = "alabaster-0.7.12"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/cc/b4/ed8dcb0d67d5cfb7f83c4d5463a7614cb1d078ad7ae890c9143edebbf072/alabaster-0.7.12.tar.gz"; - sha256 = "00nwwjj2d2ym4s2kk217x7jkx1hnczc3fvm8yxbqmsp6b0nxfqd6"; - }; - }; - "babel" = super.buildPythonPackage { - name = "babel-2.6.0"; - doCheck = false; - propagatedBuildInputs = [ - self."pytz" - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/be/cc/9c981b249a455fa0c76338966325fc70b7265521bad641bf2932f77712f4/Babel-2.6.0.tar.gz"; - sha256 = "08rxmbx2s4irp0w0gmn498vns5xy0fagm0fg33xa772jiks51flc"; - }; - }; - "certifi" = super.buildPythonPackage { - name = "certifi-2018.11.29"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/55/54/3ce77783acba5979ce16674fc98b1920d00b01d337cfaaf5db22543505ed/certifi-2018.11.29.tar.gz"; - sha256 = "1dvccavd2fzq4j37w0sznylp92ps14zi6gvlxzm23in0yhzciya7"; - }; - }; - "chardet" = super.buildPythonPackage { - name = "chardet-3.0.4"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/fc/bb/a5768c230f9ddb03acc9ef3f0d4a3cf93462473795d18e9535498c8f929d/chardet-3.0.4.tar.gz"; - sha256 = "1bpalpia6r5x1kknbk11p1fzph56fmmnp405ds8icksd3knr5aw4"; - }; - }; - "docutils" = super.buildPythonPackage { - name = "docutils-0.14"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/84/f4/5771e41fdf52aabebbadecc9381d11dea0fa34e4759b4071244fa094804c/docutils-0.14.tar.gz"; - sha256 = "0x22fs3pdmr42kvz6c654756wja305qv6cx1zbhwlagvxgr4xrji"; - }; - }; - "idna" = super.buildPythonPackage { - name = "idna-2.7"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/65/c4/80f97e9c9628f3cac9b98bfca0402ede54e0563b56482e3e6e45c43c4935/idna-2.7.tar.gz"; - sha256 = "05jam7d31767dr12x0rbvvs8lxnpb1mhdb2zdlfxgh83z6k3hjk8"; - }; - }; - "imagesize" = super.buildPythonPackage { - name = "imagesize-1.1.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/41/f5/3cf63735d54aa9974e544aa25858d8f9670ac5b4da51020bbfc6aaade741/imagesize-1.1.0.tar.gz"; - sha256 = "1dg3wn7qpwmhgqc0r9na2ding1wif9q5spz3j9zn2riwphc2k0zk"; - }; - }; - "jinja2" = super.buildPythonPackage { - name = "jinja2-2.9.6"; - doCheck = false; - propagatedBuildInputs = [ - self."markupsafe" - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/90/61/f820ff0076a2599dd39406dcb858ecb239438c02ce706c8e91131ab9c7f1/Jinja2-2.9.6.tar.gz"; - sha256 = "1zzrkywhziqffrzks14kzixz7nd4yh2vc0fb04a68vfd2ai03anx"; - }; - }; - "markupsafe" = super.buildPythonPackage { - name = "markupsafe-1.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/4d/de/32d741db316d8fdb7680822dd37001ef7a448255de9699ab4bfcbdf4172b/MarkupSafe-1.0.tar.gz"; - sha256 = "0rdn1s8x9ni7ss8rfiacj7x1085lx8mh2zdwqslnw8xc3l4nkgm6"; - }; - }; - "packaging" = super.buildPythonPackage { - name = "packaging-18.0"; - doCheck = false; - propagatedBuildInputs = [ - self."pyparsing" - self."six" - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/cf/50/1f10d2626df0aa97ce6b62cf6ebe14f605f4e101234f7748b8da4138a8ed/packaging-18.0.tar.gz"; - sha256 = "01wq9c53ix5rz6qg2c98gy8n4ff768rmanifm8m5jpjiaizj51h8"; - }; - }; - "pygments" = super.buildPythonPackage { - name = "pygments-2.3.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/63/a2/91c31c4831853dedca2a08a0f94d788fc26a48f7281c99a303769ad2721b/Pygments-2.3.0.tar.gz"; - sha256 = "1z34ms51dh4jq4h3cizp7vd1dmsxcbvffkjsd2xxfav22nn6lrl2"; - }; - }; - "pyparsing" = super.buildPythonPackage { - name = "pyparsing-2.3.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/d0/09/3e6a5eeb6e04467b737d55f8bba15247ac0876f98fae659e58cd744430c6/pyparsing-2.3.0.tar.gz"; - sha256 = "14k5v7n3xqw8kzf42x06bzp184spnlkya2dpjyflax6l3yrallzk"; - }; - }; - "pytz" = super.buildPythonPackage { - name = "pytz-2018.4"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/10/76/52efda4ef98e7544321fd8d5d512e11739c1df18b0649551aeccfb1c8376/pytz-2018.4.tar.gz"; - sha256 = "0jgpqx3kk2rhv81j1izjxvmx8d0x7hzs1857pgqnixic5wq2ar60"; - }; - }; - "requests" = super.buildPythonPackage { - name = "requests-2.20.1"; - doCheck = false; - propagatedBuildInputs = [ - self."chardet" - self."idna" - self."urllib3" - self."certifi" - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/40/35/298c36d839547b50822985a2cf0611b3b978a5ab7a5af5562b8ebe3e1369/requests-2.20.1.tar.gz"; - sha256 = "0qzj6cgv3k9wyj7wlxgz7xq0cfg4jbbkfm24pp8dnhczwl31527a"; - }; - }; - "setuptools" = super.buildPythonPackage { - name = "setuptools-40.6.2"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/b0/d1/8acb42f391cba52e35b131e442e80deffbb8d0676b93261d761b1f0ef8fb/setuptools-40.6.2.zip"; - sha256 = "0r2c5hapirlzm34h7pl1lgkm6gk7bcrlrdj28qgsvaqg3f74vfw6"; - }; - }; - "six" = super.buildPythonPackage { - name = "six-1.11.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/16/d8/bc6316cf98419719bd59c91742194c111b6f2e85abac88e496adefaf7afe/six-1.11.0.tar.gz"; - sha256 = "1scqzwc51c875z23phj48gircqjgnn3af8zy2izjwmnlxrxsgs3h"; - }; - }; - "snowballstemmer" = super.buildPythonPackage { - name = "snowballstemmer-1.2.1"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/20/6b/d2a7cb176d4d664d94a6debf52cd8dbae1f7203c8e42426daa077051d59c/snowballstemmer-1.2.1.tar.gz"; - sha256 = "0a0idq4y5frv7qsg2x62jd7rd272749xk4x99misf5rcifk2d7wi"; - }; - }; - "sphinx" = super.buildPythonPackage { - name = "sphinx-1.8.2"; - doCheck = false; - propagatedBuildInputs = [ - self."six" - self."jinja2" - self."pygments" - self."docutils" - self."snowballstemmer" - self."babel" - self."alabaster" - self."imagesize" - self."requests" - self."setuptools" - self."packaging" - self."sphinxcontrib-websupport" - self."typing" - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/4c/ea/7388faba7cf02999e1bc42f6a8eb1ea0120aec3dd93474cee21cea2d693f/Sphinx-1.8.2.tar.gz"; - sha256 = "1sia2h5rfzy76rbsd69ghr8bbidhsjzzinf3f523dcmivp5k41qj"; - }; - }; - "sphinx-rtd-theme" = super.buildPythonPackage { - name = "sphinx-rtd-theme-0.4.1"; - doCheck = false; - propagatedBuildInputs = [ - self."sphinx" - ]; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/f2/b0/a1933d792b806118ddbca6699f2e2c844d9b1b16e84a89d7effd5cd2a800/sphinx_rtd_theme-0.4.1.tar.gz"; - sha256 = "1xkyqam8dzbjaymdyvkiif85m4y3jf8crdiwlgcfp8gqcj57aj9v"; - }; - }; - "sphinxcontrib-websupport" = super.buildPythonPackage { - name = "sphinxcontrib-websupport-1.1.0"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/07/7a/e74b06dce85555ffee33e1d6b7381314169ebf7e31b62c18fcb2815626b7/sphinxcontrib-websupport-1.1.0.tar.gz"; - sha256 = "1ff3ix76xi1y6m99qxhaq5161ix9swwzydilvdya07mgbcvpzr4x"; - }; - }; - "typing" = super.buildPythonPackage { - name = "typing-3.6.6"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/bf/9b/2bf84e841575b633d8d91ad923e198a415e3901f228715524689495b4317/typing-3.6.6.tar.gz"; - sha256 = "0ba9acs4awx15bf9v3nrs781msbd2nx826906nj6fqks2bvca9s0"; - }; - }; - "urllib3" = super.buildPythonPackage { - name = "urllib3-1.25.2"; - doCheck = false; - src = fetchurl { - url = "https://files.pythonhosted.org/packages/9a/8b/ea6d2beb2da6e331e9857d0a60b79ed4f72dcbc4e2c7f2d2521b0480fda2/urllib3-1.25.2.tar.gz"; - sha256 = "1nq2k4pss1ihsjh02r41sqpjpm5rfqkjfysyq7g7n2i1p7c66c55"; - }; - }; - -### Test requirements - - -} diff --git a/docs/requirements_docs.txt b/docs/requirements_docs.txt --- a/docs/requirements_docs.txt +++ b/docs/requirements_docs.txt @@ -1,7 +1,11 @@ -sphinx==1.8.2 -six==1.11.0 -sphinx_rtd_theme==0.4.1 -docutils==0.16.0 -pygments==2.3.0 -markupsafe==1.0.0 -jinja2==2.9.6 +sphinx==7.2.6 + +furo==2023.9.10 +sphinx-press-theme==0.8.0 +sphinx-rtd-theme==1.3.0 + +pygments==2.16.1 + +docutils<0.19 +markupsafe==2.1.3 +jinja2==3.1.2