update documentation/reference

Author: FredHappyface

documentation/reference/MODULES.md

@@ -1,9 +1,8 @@
-# Checkrequirements Modules
+# Checkrequirements Index
 
-> Auto-generated documentation modules index.
+> Auto-generated documentation index.
 
-Full list of [Checkrequirements](README.md#checkrequirements-index) project modules.
+A full list of `Checkrequirements` project modules.
 
-- [Checkrequirements Index](README.md#checkrequirements-index)
 - [Checkrequirements](checkrequirements/index.md#checkrequirements)
     - [Module](checkrequirements/module.md#module)

documentation/reference/README.md

@@ -1,49 +1,55 @@
 # Checkrequirements
 
+[Checkrequirements Index](../README.md#checkrequirements-index) /
+Checkrequirements
+
 > Auto-generated documentation for [checkrequirements](../../../checkrequirements/__init__.py) module.
 
-Check that your requirements.txt is up to date with the most recent packageversions.
-
-- [Checkrequirements](../README.md#checkrequirements-index) / [Modules](../MODULES.md#checkrequirements-modules) / Checkrequirements
-    - [Dependency](#dependency)
-    - [UpdateCompatible](#updatecompatible)
-    - [checkRequirements](#checkrequirements)
-    - [cli](#cli)
-    - [partCmp](#partcmp)
-    - [semCmp](#semcmp)
-    - [semPad](#sempad)
-    - [semver](#semver)
-    - [updateCompatible](#updatecompatible)
-    - Modules
-        - [Module](module.md#module)
+- [Checkrequirements](#checkrequirements)
+  - [Dependency](#dependency)
+  - [UpdateCompatible](#updatecompatible)
+  - [checkRequirements](#checkrequirements)
+  - [cli](#cli)
+  - [partCmp](#partcmp)
+  - [semCmp](#semcmp)
+  - [semPad](#sempad)
+  - [semver](#semver)
+  - [updateCompatible](#updatecompatible)
+  - [Modules](#modules)
 
 ## Dependency
 
-[[find in source code]](../../../checkrequirements/__init__.py#L25)
+[Show source in __init__.py:25](../../../checkrequirements/__init__.py#L25)
+
+Dependency type.
+
+#### Signature
 
 ```python
 class Dependency(typing.TypedDict):
+    ...
 ```
 
-Dependency type.
+
 
 ## UpdateCompatible
 
-[[find in source code]](../../../checkrequirements/__init__.py#L18)
+[Show source in __init__.py:18](../../../checkrequirements/__init__.py#L18)
+
+UpdateCompatible type.
+
+#### Signature
 
 ```python
 class UpdateCompatible(typing.TypedDict):
+    ...
 ```
 
-UpdateCompatible type.
 
-## checkRequirements
 
-[[find in source code]](../../../checkrequirements/__init__.py#L190)
+## checkRequirements
 
-```python
-def checkRequirements(requirementsFile: str) -> list[Dependency]:
-```
+[Show source in __init__.py:190](../../../checkrequirements/__init__.py#L190)
 
 Check that your requirements.txt is up to date with the most recent package
 versions. Put in a function so dependants can use this function rather than
@@ -55,31 +61,41 @@ reimplement it themselves.
 
 #### Returns
 
-- `Dependency` - dictionary containing info on each requirement such as the name,
+- [Dependency](#dependency) - dictionary containing info on each requirement such as the name,
 specs (from requirements_parser), ver (most recent version), compatible
 (is our version compatible with ver)
 
+#### Signature
+
+```python
+def checkRequirements(requirementsFile: str) -> list[Dependency]:
+    ...
+```
+
 #### See also
 
 - [Dependency](#dependency)
 
+
+
 ## cli
 
-[[find in source code]](../../../checkrequirements/__init__.py#L211)
+[Show source in __init__.py:211](../../../checkrequirements/__init__.py#L211)
+
+CLI entry point.
+
+#### Signature
 
 ```python
 def cli():
+    ...
 ```
 
-CLI entry point.
+
 
 ## partCmp
 
-[[find in source code]](../../../checkrequirements/__init__.py#L62)
-
-```python
-def partCmp(verA: str, verB: str) -> int:
-```
+[Show source in __init__.py:62](../../../checkrequirements/__init__.py#L62)
 
 Compare parts of a semver.
 
@@ -92,14 +108,19 @@ Compare parts of a semver.
 
 - `int` - 0 if equal, 1 if verA > verB and -1 if verA < verB
 
-## semCmp
-
-[[find in source code]](../../../checkrequirements/__init__.py#L149)
+#### Signature
 
 ```python
-def semCmp(versionA: str, versionB: str, sign: str) -> bool:
+def partCmp(verA: str, verB: str) -> int:
+    ...
 ```
 
+
+
+## semCmp
+
+[Show source in __init__.py:149](../../../checkrequirements/__init__.py#L149)
+
 Compare two semvers of any length. e.g. 1.1 and 2.2.2.
 
 #### Arguments
@@ -116,14 +137,19 @@ Compare two semvers of any length. e.g. 1.1 and 2.2.2.
 
 - `bool` - true if the comparison is met. e.g. 1.1.1, 2.2.2, <= -> True
 
-## semPad
-
-[[find in source code]](../../../checkrequirements/__init__.py#L46)
+#### Signature
 
 ```python
-def semPad(ver: list[str], length: int) -> list[str]:
+def semCmp(versionA: str, versionB: str, sign: str) -> bool:
+    ...
 ```
 
+
+
+## semPad
+
+[Show source in __init__.py:46](../../../checkrequirements/__init__.py#L46)
+
 Pad a semver list to the required size. e.g. ["1", "0"] to ["1", "0", "0"].
 
 #### Arguments
@@ -135,14 +161,19 @@ Pad a semver list to the required size. e.g. ["1", "0"] to ["1", "0", "0"].
 
 - `list[str]` - the new semver
 
-## semver
-
-[[find in source code]](../../../checkrequirements/__init__.py#L34)
+#### Signature
 
 ```python
-def semver(version: str) -> list[str]:
+def semPad(ver: list[str], length: int) -> list[str]:
+    ...
 ```
 
+
+
+## semver
+
+[Show source in __init__.py:34](../../../checkrequirements/__init__.py#L34)
+
 Convert a semver/ python-ver string to a list in the form major, minor patch
 
 #### Arguments
@@ -153,14 +184,19 @@ Convert a semver/ python-ver string to a list in the form major, minor patch
 
 - `list[str]` - A list in the form major, minor, patch
 
-## updateCompatible
-
-[[find in source code]](../../../checkrequirements/__init__.py#L169)
+#### Signature
 
 ```python
-def updateCompatible(req: Requirement) -> UpdateCompatible:
+def semver(version: str) -> list[str]:
+    ...
 ```
 
+
+
+## updateCompatible
+
+[Show source in __init__.py:169](../../../checkrequirements/__init__.py#L169)
+
 Check if the most recent version of a python requirement is compatible with
 the current version.
 
@@ -170,10 +206,23 @@ the current version.
 
 #### Returns
 
-- `UpdateCompatible` - return a dict of the most recent version (ver) and
+- [UpdateCompatible](#updatecompatible) - return a dict of the most recent version (ver) and
 is our requirement from requirements.txt or similar compatible
 with the new version per the version specifier (compatible)
 
+#### Signature
+
+```python
+def updateCompatible(req: Requirement) -> UpdateCompatible:
+    ...
+```
+
 #### See also
 
 - [UpdateCompatible](#updatecompatible)
+
+
+
+## Modules
+
+- [Module](./module.md)

documentation/reference/checkrequirements/index.md

@@ -1,7 +1,9 @@
 # Module
 
-> Auto-generated documentation for [checkrequirements.__main__](../../../checkrequirements/__main__.py) module.
+[Checkrequirements Index](../README.md#checkrequirements-index) /
+[Checkrequirements](./index.md#checkrequirements) /
+Module
 
-Entry point for python -m checkrequirements.
+> Auto-generated documentation for [checkrequirements.__main__](../../../checkrequirements/__main__.py) module.
 
-- [Checkrequirements](../README.md#checkrequirements-index) / [Modules](../MODULES.md#checkrequirements-modules) / [Checkrequirements](index.md#checkrequirements) / Module
+- [Module](#module)