Updated docs.

Author: domdfcoding

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020 Dominic Davis-Foster
+Copyright © 2020 Dominic Davis-Foster
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

doc-source/index.rst

@@ -112,6 +112,58 @@ Installation
 
 .. extensions:: seed_intersphinx_mapping
 
+Configuration
+-----------------
+
+.. confval:: pkg_requirements_source
+
+	The requirements source.
+
+	* If this is a list, it is taken to be a list of directories
+	  in which to search for ``requirements.txt`` files.
+	  Any files found will be used to compile the list of requirements.
+
+	* If this is the string ``requirements``,
+	  the list of requirements will be determined from the ``requirements.txt`` file
+	  in the  directory given by the :confval:`pkg_requirements_source` option.
+
+	Currently, no other sources are supported.
+
+
+.. confval:: repository_root
+
+	The path to the repository root, relative to the Sphinx source directory.
+
+	E.g., for this repository structure:
+
+	::
+
+		.
+		├── LICENSE
+		├── README.rst
+		├── doc-source  # <- this is the Sphinx source directory
+		|   ├── index.rst
+		|   └── conf.py
+		├── requirements.txt  # <- this is the file containing the requirements
+		├── seed_intersphinx_mapping
+		├── setup.py
+		├── tests
+		└── tox.ini
+
+	the value would be ``..``, which is the default.
+
+
+Caching
+--------
+
+``seed_intersphinx_mapping`` caches the documentation URLs for PyPI packages.
+The cache can be cleared as follows:
+
+.. prompt:: bash
+
+	python3 -m seed_intersphinx_mapping
+
+.. TODO:: automatic cache clearing
 
 .. toctree::
 	:hidden:

seed_intersphinx_mapping/__init__.py

@@ -5,7 +5,7 @@
 Populate the Sphinx 'intersphinx_mapping' dictionary from the project's requirements.
 """
 #
-#  Copyright (c) 2020 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
 #
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
 #  of this software and associated documentation files (the "Software"), to deal

seed_intersphinx_mapping/cache.py

@@ -5,7 +5,7 @@
 Caching functions.
 """
 #
-#  Copyright (c) 2020 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
 #
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
 #  of this software and associated documentation files (the "Software"), to deal

seed_intersphinx_mapping/core.py

@@ -5,7 +5,7 @@
 Core functionality.
 """
 #
-#  Copyright (c) 2020 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
 #
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
 #  of this software and associated documentation files (the "Software"), to deal
@@ -84,7 +84,7 @@ def get_sphinx_doc_url(pypi_name: str) -> str:
 	:return: The URl of the project's Sphinx documentation.
 
 	:raises: | :exc:`ValueError` if the url could not be determined.
-		| :exc:`slumber.exceptions.HttpNotFoundError` if the project could not be found on PyPI.
+		| :exc:`apeye.slumber_url.HttpNotFoundError` if the project could not be found on PyPI.
 	"""
 
 	pypi_url: SlumberURL = PYPI_API / pypi_name / "json"

seed_intersphinx_mapping/requirements_parsers.py

@@ -7,7 +7,7 @@
 .. TODO:: Other formats, e.g. setup.cfg, flit, poetry
 """
 #
-#  Copyright (c) 2020 Dominic Davis-Foster <[email protected]>
+#  Copyright © 2020 Dominic Davis-Foster <[email protected]>
 #
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
 #  of this software and associated documentation files (the "Software"), to deal