Merge pull request #296 from manparvesh/v2

add documentation website using mkdocs

docs/docs/contributors.md

@@ -0,0 +1,61 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
+participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
+disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
+project or its community. Examples of representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed representative at an online or offline
+event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
+[email protected]. The project team will review and investigate all complaints, and will respond in a
+way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with
+regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available
+at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+
+[version]: http://contributor-covenant.org/version/1/4/

docs/docs/index.md

@@ -0,0 +1,77 @@
+# Yoda PA
+
+[![Github CI](https://github.com/yoda-pa/yoda/actions/workflows/ci.yml/badge.svg)](https://github.com/yoda-pa/yoda/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/yodapa.svg)](https://badge.fury.io/py/yodapa)
+
+Personal Assistant on the command line.
+
+![Yoda](logo.png)
+
+## Installation
+
+```bash
+pip install yodapa
+
+yoda --help
+```
+
+## Configure Yoda
+
+```bash
+yoda configure
+```
+
+## Plugins
+
+### Write your own plugin for Yoda
+
+Simply create a class with the `@yoda_plugin(name="plugin-name")` decorator and add methods to it. The non-private
+methods will be automatically added as sub-commands to Yoda, with the command being the name you provide to the
+decorator.
+
+```python
+import typer
+from yodapa.plugin_manager.decorator import yoda_plugin
+
+
+@yoda_plugin(name="hi")
+class HiPlugin:
+    """
+    Hi plugin. Say hello.
+
+    Example:
+        $ yoda hi hello --name MP
+        $ yoda hi hello
+    """
+
+    def hello(self, name: str = None):
+        """Say hello."""
+        name = name or "Padawan"
+        typer.echo(f"Hello {name}!")
+
+    def _private_method_should_not_be_added(self):
+        """This method should not be added as a command."""
+        raise NotImplementedError()
+```
+
+## Development setup
+
+```bash
+# 1. Install poetry from their website: https://python-poetry.org/docs/#installation
+
+# 2. Install dependencies and this package
+poetry install
+
+# 3. Activate the virtual environment
+poetry shell
+
+# Now you should be able to communicate with yoda
+yoda --help
+```
+
+### Testing
+
+```bash
+# Run tests when in the virtual environment
+pytest
+```

docs/docs/license.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Man Parvesh Singh Randhawa
+
+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/docs/modules.md

@@ -0,0 +1,3 @@
+# Modules
+
+::: yodapa.config.ConfigManager

docs/docs/plugins.md

@@ -0,0 +1,9 @@
+# Plugin Management
+
+## Decorator
+
+::: yodapa.plugin_manager.decorator
+
+## Plugin Manager
+
+::: yodapa.plugin_manager.plugin.PluginManager

docs/mkdocs.yml

@@ -0,0 +1,34 @@
+site_name: Yoda PA
+site_url: https://yoda-pa.github.io/yoda
+repo_url: https://github.com/yoda-pa/yoda
+repo_name: yoda-pa/yoda
+edit_uri: edit/main/docs/
+
+theme:
+  name: material
+  palette:
+    primary: 'teal'
+    accent: 'purple'
+  font:
+    text: 'Roboto'
+    code: 'Roboto Mono'
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - search.highlight
+    - toc.integrate
+    - instant_loading
+
+plugins:
+  - search
+  - mkdocstrings:
+      default_handler: python
+
+nav:
+  - Home: index.md
+  - Documentation:
+      - Plugins: plugins.md
+      - Modules: modules.md
+  - About:
+      - Contributors: contributors.md
+      - License: license.md