Change package to semantic versioning and indicate stable

CHANGELOG.md

@@ -1,4 +1,16 @@
-### wikirepo 0.1.1.5 (March 28, 2021)
+# Changelog
+
+wikirepo tries to follow [semantic versioning](https://semver.org/), a MAJOR.MINOR.PATCH version where increments are made of the:
+
+- MAJOR version when we make incompatible API changes
+- MINOR version when we add functionality in a backwards compatible manner
+- PATCH version when we make backwards compatible bug fixes
+
+# wikirepo 1.0.0 (December 28th, 2021)
+
+- Release switches wikirepo over to [semantic versioning](https://semver.org/) and indicates that it is stable
+
+# wikirepo 0.1.1.5 (March 28th, 2021)
 
 Changes include:
 
@@ -7,19 +19,19 @@ Changes include:
 - Extensive code formatting to improve quality and style
 - Fixes to vulnerabilities through exception use
 
-### wikirepo 0.1.0 (Feb 23, 2021)
+# wikirepo 0.1.0 (Feb 23rd, 2021)
 
 First stable release of wikirepo
 
-Additions include:
+Changes include:
 
 - Full documentation of the package
 - Virtual environment files
 - Bug fixes
 - Extensive testing of all modules with GH Actions and Codecov
 - Code of conduct and contribution guidelines
 
-### wikirepo 0.0.2 (Dec 8, 2020)
+# wikirepo 0.0.2 (Dec 8th, 2020)
 
 The minimum viable product of wikirepo:
 

docs/source/conf.py

@@ -15,16 +15,14 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
-import wikirepo
-
 # -- Project information -----------------------------------------------------
 
 project = "wikirepo"
 copyright = "2020-2021, wikirepo developers (BSD License)"
 author = "wikirepo developers"
 
 # The full version, including alpha/beta/rc tags
-release = "0.1.1.7"
+release = "1.0.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -42,6 +40,20 @@
 numpydoc_show_inherited_class_members = False
 numpydoc_show_class_members = False
 
+# NOT to sort autodoc functions in alphabetical order
+autodoc_member_order = "bysource"
+
+# To avoid installing dependencies when building doc
+# https://stackoverflow.com/a/15912502/8729698
+autodoc_mock_imports = [
+    "numpy",
+    "pandas",
+    "pytest",
+    "pytest-cov",
+    "tqdm",
+    "Wikidata",
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

setup.py

@@ -14,11 +14,15 @@
 with open(os.path.join(package_directory, "requirements.txt")) as req_file:
     requirements = req_file.readlines()
 
+on_rtd = os.environ.get("READTHEDOCS") == "True"
+if on_rtd:
+    requirements = []
+
 setup_args = dict(
     name="wikirepo",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
-    version="0.1.1.7",
+    version="1.0.0",
     author="Andrew Tavis McAllister",
     author_email="andrew.t.mcallister@gmail.com",
     classifiers=[