Update docs to use mkdocstrings.

Author: hreikin

docs/README.md

@@ -11,7 +11,9 @@ authors:
 
 <!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
 
-An embeddable tkinter based Markdown editor with HTML preview.
+An embeddable tkinter based Markdown editor with HTML preview. The editor has 
+syntax highlighting supplied by `Pygments` and the HTML preview window is 
+provided by `tkinterweb`.
 
 - Github Link: [https://github.com/hreikin/tkintermd](https://github.com/hreikin/tkintermd)  
 - PyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)  

docs/assets/python-logo.png

@@ -5,8 +5,8 @@ Contributions are what make the open source community such an amazing place to l
 If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
 Don't forget to give the project a star! Thanks again!
 
-1. Fork the Project
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
+- Fork the Project
+- Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+- Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+- Push to the Branch (`git push origin feature/AmazingFeature`)
+- Open a Pull Request

docs/code-of-conduct.md

@@ -0,0 +1,7 @@
+Copyright 2022 @hreikin ([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 in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/contributing-to-tkintermd.md

@@ -1,21 +1,10 @@
-# `tkintermd` Constants
+# `constants`
 
 ::: tkintermd.tkintermd_constants
     handler: python
     <!-- selection:
       members:
-        - popup
-        - on_scrollbar
-        - on_mousewheel
-        - select_all
-        - find
-        - open_md_file
-        - save_as_md_file
-        - save_md_file
-        - on_input_change
-        - load_style
-        - check_markdown
-        - apply_markdown_both_sides -->
+        - cur_file -->
     rendering:
       show_root_heading: true
-      show_source: true
+      show_source: false

docs/license.md

@@ -1,4 +1,4 @@
-# TkinterMDFrame
+# `TkinterMDFrame`
 
 ::: tkintermd.tkintermd_frame.TkinterMDFrame
     handler: python
@@ -17,5 +17,5 @@
         - check_markdown
         - apply_markdown_both_sides
     rendering:
-      show_root_heading: false
+      show_root_heading: true
       show_source: false

docs/reference/tkintermd-constants.md

@@ -1,4 +1,4 @@
-# Lexer
+# `Lexer`
 
 ::: tkintermd.tkintermd_frame.Lexer
     handler: python
@@ -18,4 +18,4 @@
         - apply_markdown_both_sides -->
     rendering:
       show_root_heading: true
-      show_source: true
+      show_source: false