Update documtation

CHANGELOG.md

@@ -5,37 +5,48 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this
 project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+*
+
+### Fixed
+
+*
+
+
 
 ## [0.21.1] - 2022-09-03
 
 ### Added
-* Use Python 3.11 non-beta in CI (#438 by @bbc2)
-* Modernize variables code (#434 by @Nougat-Waffle)
-* Modernize main.py and parser.py code (#435 by @Nougat-Waffle)
-* Improve conciseness of cli.py and __init__.py (#439 by @Nougat-Waffle)
-* Improve error message for `get` and `list` commands when env file can't be opened (#441 by @bbc2)
-* Updated Licence to align with BSD OSI template (#433 by @lsmith77)
+* Use Python 3.11 non-beta in CI (#438 by [@bbc2])
+* Modernize variables code (#434 by [@Nougat-Waffle])
+* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])
+* Improve conciseness of cli.py and __init__.py (#439 by [@Nougat-Waffle])
+* Improve error message for `get` and `list` commands when env file can't be opened (#441 by [@bbc2])
+* Updated License to align with BSD OSI template (#433 by [@lsmith77])
 
 
 ### Fixed
-* Fix Out-of-scope error when "dest" variable is undefined (#413 by @theGOTOguy)
-* Fix IPython test warning about deprecated `magic` (#440 by @bbc2)
-* Fix type hint for dotenv_path var, add StrPath alias (#432 by @eaf)
+* Fix Out-of-scope error when "dest" variable is undefined (#413 by [@theGOTOguy])
+* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])
+* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])
 
 ## [0.21.0] - 2022-09-03
 
 ### Added
-* CLI: add support for invocations via 'python -m'. (#395 by @theskumar)
-* `load_dotenv` function now returns `False`. (#388 by @larsks)
-* CLI: add --format= option to list command. (#407 by @sammck)
+* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])
+* `load_dotenv` function now returns `False`. (#388 by [@larsks])
+* CLI: add --format= option to list command. (#407 by [@sammck])
 
 ### Fixed
-* Drop Python 3.5 and 3.6 and upgrade GA (#393 by @eggplants)
-* Use `open` instead of `io.open`. (#389 by @rabinadk1)
-* Improve documentation for variables without a value (#390 by @bbc2)
-* Add `parse_it` to Related Projects (#410 by @naorlivne)
-* Update README.md (#415 by @harveer07)
-* Improve documentation with direct use of MkDocs (#398 by @bbc2)
+* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])
+* Use `open` instead of `io.open`. (#389 by [@rabinadk1])
+* Improve documentation for variables without a value (#390 by [@bbc2])
+* Add `parse_it` to Related Projects (#410 by [@naorlivne])
+* Update README.md (#415 by [@harveer07])
+* Improve documentation with direct use of MkDocs (#398 by [@bbc2])
 
 ## [0.20.0] - 2022-03-24
 
@@ -326,6 +337,7 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 [@bbc2]: https://github.com/bbc2
 [@befeleme]: https://github.com/befeleme
 [@cjauvin]: https://github.com/cjauvin
+[@eaf]: https://github.com/eaf
 [@earlbread]: https://github.com/earlbread
 [@eggplants]: https://github.com/@eggplants
 [@ekohl]: https://github.com/ekohl
@@ -337,13 +349,16 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 [@harveer07]: https://github.com/@harveer07
 [@jadutter]: https://github.com/jadutter
 [@larsks]: https://github.com/@larsks
+[@lsmith77]: https://github.com/lsmith77
 [@mgorny]: https://github.com/mgorny
 [@naorlivne]: https://github.com/@naorlivne
+[@Nougat-Waffle]: https://github.com/Nougat-Waffle
 [@qnighy]: https://github.com/qnighy
 [@rabinadk1]: https://github.com/@rabinadk1
 [@sammck]: https://github.com/@sammck
 [@snobu]: https://github.com/snobu
 [@techalchemy]: https://github.com/techalchemy
+[@theGOTOguy]: https://github.com/theGOTOguy
 [@theskumar]: https://github.com/theskumar
 [@ulyssessouza]: https://github.com/ulyssessouza
 [@venthur]: https://github.com/venthur
@@ -352,7 +367,8 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 [@zueve]: https://github.com/zueve
 
 
-[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...HEAD
+[Unreleased]: https://github.com/theskumar/python-dotenv/compare/v0.21.1...HEAD
+[0.21.1]: https://github.com/theskumar/python-dotenv/compare/v0.21.0...v0.21.1
 [0.21.0]: https://github.com/theskumar/python-dotenv/compare/v0.20.0...v0.21.0
 [0.20.0]: https://github.com/theskumar/python-dotenv/compare/v0.19.2...v0.20.0
 [0.19.2]: https://github.com/theskumar/python-dotenv/compare/v0.19.1...v0.19.2

LICENSE

@@ -3,14 +3,16 @@ Copyright (c) 2014, Saurabh Kumar (python-dotenv), 2013, Ted Tieken (django-dote
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-    * Neither the name of django-dotenv nor the names of its contributors
-      may be used to endorse or promote products derived from this software
-      without specific prior written permission.
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+- Neither the name of django-dotenv nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

docs/license.md

@@ -0,0 +1 @@
+../LICENSE

docs/reference.md

@@ -1,3 +1,2 @@
-# Reference
+# ::: dotenv
 
-::: dotenv

mkdocs.yml

@@ -5,8 +5,15 @@ theme:
   name: material
   palette:
     primary: green
+  features:
+    - toc.follow
+    - navigation.sections
+
 markdown_extensions:
   - mdx_truly_sane_lists
+  - toc:
+      toc_depth: 2
+
 plugins:
   - mkdocstrings:
       handlers:
@@ -21,3 +28,4 @@ nav:
   - Changelog: changelog.md
   - Contributing: contributing.md
   - Reference: reference.md
+  - License: license.md