Docs (#3)

* Added hythen to package name

* Removed path manipulation in conf.py

* Updated makefile to target package

* unhyphenated project name

* Updated readme

README.md

@@ -81,6 +81,15 @@ To make thing move a bit faster, use the script `./rename-package.sh` to rename
 
 Will rename the package and all references to "acoolnewname"
 
+After doing this it is recommended to also run:
+
+```
+cd docs
+make apidoc
+```
+
+To keep your documentation in sync with the package name. You may need to delete a file called `mypackage.rst` from `./docs/sources/...`
+
 ### Deploying Docs to GitHub Pages
 
 If you want docs to be published to github pages automatically, go to your repo settings and enable docs from GitHub Actions and the workflows will do the rest.

docs/Makefile

@@ -20,4 +20,4 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 apidoc:
-	@sphinx-apidoc -f ../src/* -o sources
+	@sphinx-apidoc -f ../src/mypackage -o sources

docs/conf.py

@@ -6,11 +6,6 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-import os, sys
-
-path = os.path.abspath("../src")
-sys.path.append(path)
-
 import mypackage
 
 project = 'My Project'

docs/sources/modules.rst

@@ -1,5 +1,5 @@
 mypackage
-=======
+=========
 
 .. toctree::
    :maxdepth: 4

docs/sources/project.rst → docs/sources/mypackage.rst

@@ -1,11 +1,11 @@
 mypackage package
-===============
+=================
 
 Submodules
 ----------
 
 mypackage.module module
----------------------
+-----------------------
 
 .. automodule:: mypackage.module
    :members: