diff options
| author | Cody Logan <clpo13@gmail.com> | 2020-01-08 10:16:58 -0800 |
|---|---|---|
| committer | Cody Logan <clpo13@gmail.com> | 2020-01-08 10:16:58 -0800 |
| commit | 21d800b1bfec1b3ca2fbd4cce8b8ade507c6382a (patch) | |
| tree | 35a1695908690b1048fa180f07f62abdc702b41a | |
| parent | f599b85ba5a5fe7123e0d77bf7b9f6c738471bc8 (diff) | |
| download | alphanum-0.2.0.tar.gz alphanum-0.2.0.zip | |
Link Python stdlib docsv0.2.0
| -rw-r--r-- | alphanum/__init__.py | 2 | ||||
| -rw-r--r-- | alphanum/alphanum.py | 8 | ||||
| -rw-r--r-- | docs/conf.py | 9 | ||||
| -rw-r--r-- | pyproject.toml | 2 |
4 files changed, 13 insertions, 8 deletions
diff --git a/alphanum/__init__.py b/alphanum/__init__.py index 278216d..5736c89 100644 --- a/alphanum/__init__.py +++ b/alphanum/__init__.py @@ -1,3 +1,3 @@ from .alphanum import generate # noqa: F401 -__version__ = '0.2.0.dev2' +__version__ = '0.2.0' diff --git a/alphanum/alphanum.py b/alphanum/alphanum.py index 6f7c103..3f16d3c 100644 --- a/alphanum/alphanum.py +++ b/alphanum/alphanum.py @@ -8,12 +8,12 @@ POP = string.ascii_letters + string.digits def generate(length: int = 1) -> str: - """Generates a random string of alphanumeric characters of the given length + """Generates a random string of alphanumeric characters of the given length. If no length is specified, a single character is returned. - On Python 3.5, this string is pseudo-randomly generated using the random - module. With 3.6 and later, the randomness is generated with the secrets - module, making the randomization cryptographically strong. + On Python 3.5, this string is pseudo-randomly generated using + :py:mod:`random`. With 3.6 and later, the randomness is generated with + :py:mod:`secrets`, making the randomization cryptographically strong. Args: length (:obj:`int`, optional): Desired string length. Defaults to 1. diff --git a/docs/conf.py b/docs/conf.py index 7d685d9..f8370f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,7 +22,7 @@ copyright = '2020, Cody Logan' author = 'Cody Logan' # The full version, including alpha/beta/rc tags -release = '0.2.0.dev1' +release = '0.2.0' # -- General configuration --------------------------------------------------- @@ -31,7 +31,8 @@ release = '0.2.0.dev1' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinxcontrib.napoleon' + 'sphinx.ext.napoleon', + 'sphinx.ext.intersphinx', ] # Add any paths that contain templates here, relative to this directory. @@ -42,6 +43,10 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), +} + # -- Options for HTML output ------------------------------------------------- diff --git a/pyproject.toml b/pyproject.toml index e99c3b0..a9d20a6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "alphanum" -version = "0.2.0.dev2" +version = "0.2.0" description = "Generates random alphanumeric strings." authors = ["Cody Logan <clpo13@gmail.com>"] license = "MIT" |
