Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Commit

Permalink
v0.3.0 New login mechanism (#7)
Browse files Browse the repository at this point in the history 
* Update login method (hashing)

* Better typing and formats

* v0.3.0

* Little formatting
  • Loading branch information
@lazykern
lazykern authored Nov 22, 2022
1 parent c8d38de commit 342fa20
Show file tree
Hide file tree
Showing 11 changed files with 784 additions and 649 deletions.
167 changes: 89 additions & 78 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,24 @@
import re
import logging

sys.path.insert(0, os.path.abspath('..'))
sys.path.append(os.path.abspath('extensions'))
sys.path.insert(0, os.path.abspath(".."))
sys.path.append(os.path.abspath("extensions"))

# -- Project information -----------------------------------------------------

project = 'pymyku'
copyright = '2022, Phusit Somboonyingsuk'
author = 'Phusit Somboonyingsuk'
project = "pymyku"
copyright = "2022, Phusit Somboonyingsuk"
author = "Phusit Somboonyingsuk"

release = ''
with open('../pymyku/__init__.py') as f:
release = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(),
re.MULTILINE).group(1)
release = ""
with open("../pymyku/__init__.py") as f:
release = re.search(
r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE
)
if not release:
raise RuntimeError("Unable to find version string.")

release = release.group(1)

version = release

Expand All @@ -39,65 +44,67 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel',
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinxcontrib_trio',
'nitpick_file_ignorer',
'builder',
'details',
'exception_hierarchy',
'attributetable',
'resourcelinks',
"sphinx.ext.autodoc",
"sphinx.ext.autosectionlabel",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinxcontrib_trio",
"nitpick_file_ignorer",
"builder",
"details",
"exception_hierarchy",
"attributetable",
"resourcelinks",
]

autodoc_member_order = 'bysource'
autodoc_typehints = 'none'
autodoc_member_order = "bysource"
autodoc_typehints = "none"

intersphinx_mapping = {
'py': ('https://docs.python.org/3', None),
'req': ('https://docs.python-requests.org/en/latest/', None)
"py": ("https://docs.python.org/3", None),
"req": ("https://docs.python-requests.org/en/latest/", None),
}

gettext_compact = False

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

source_suffix = ['.rst', '.md']
source_suffix = [".rst", ".md"]

pygments_style = 'vim'
pygments_style = "vim"

# Ignore warnings about inconsistent order and/or count of references in translated messages.
# This makes no sense, different languages can have different word order...
def _i18n_warning_filter(record: logging.LogRecord) -> bool:
return not record.msg.startswith((
'inconsistent references in translated message',
'inconsistent term references in translated message',
))
return not record.msg.startswith(
(
"inconsistent references in translated message",
"inconsistent term references in translated message",
)
)


_i18n_logger = logging.getLogger('sphinx')
_i18n_logger = logging.getLogger("sphinx")
_i18n_logger.addFilter(_i18n_warning_filter)

# -- 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 = 'basic'
html_theme = "basic"

# 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']
html_static_path = ["_static"]

# 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
Expand All @@ -106,108 +113,105 @@ def _i18n_warning_filter(record: logging.LogRecord) -> bool:
# }

# 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
# "<project> v<release> 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_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 = './assets/pymyku_logo.ico'
html_favicon = "./assets/pymyku_logo.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']
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 = []
# 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 = '%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 = True

# 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 <link> 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

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
#html_search_language = 'en'
# html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.

html_search_scorer = '_static/scorer.js'
html_search_scorer = "_static/scorer.js"
# html_search_scorer = './docs/_static/scorer.js'

html_js_files = ['custom.js', 'settings.js', 'copy.js', 'sidebar.js']
html_js_files = ["custom.js", "settings.js", "copy.js", "sidebar.js"]

# Output file base name for HTML help builder.
htmlhelp_basename = 'pymykudoc'
htmlhelp_basename = "pymykudoc"

# -- 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': '',

# Latex figure (float) alignment
#'figure_align': 'htbp',
}
Expand All @@ -216,56 +220,63 @@ def _i18n_warning_filter(record: logging.LogRecord) -> bool:
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'pymyku.tex', 'pymyku Documentation', 'phusitsom', 'manual'),
("index", "pymyku.tex", "pymyku Documentation", "phusitsom", "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 = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# 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

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'pymyku', 'pymyku Documentation', ['phusitsom'], 1)]
man_pages = [("index", "pymyku", "pymyku Documentation", ["phusitsom"], 1)]

# If true, show URL addresses after external links.
#man_show_urls = False
# 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', 'pymyku', 'pymyku Documentation', 'phusitsom', 'pymyku',
'One line description of project.', 'Miscellaneous'),
(
"index",
"pymyku",
"pymyku Documentation",
"phusitsom",
"pymyku",
"One line description of 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
Loading

0 comments on commit 342fa20

Please sign in to comment.