Merge pull request #107 from staticdev/add-sphinx-click

Add sphinx-click

Author: Thiago C. D'Ávila

README.rst

@@ -39,10 +39,9 @@ Git Portfolio
 Features
 --------
 
-* Mass create issues.
-* Mass create pull requests.
-* Mass merge pull requests.
-* Mass delete branches by name.
+* Configure multiple working repositories.
+* Batch `git checkout`, `git commit`, `git pull`, `git push` and `git status`.
+* Batch creation of issues, creation of pull requests, merge of pull requests and deletion branches by name on GitHub.
 
 
 Requirements
@@ -66,7 +65,9 @@ You can install *Git Portfolio* via pip_ from PyPI_:
 Usage
 -----
 
-* TODO.
+.. click:: git_portfolio.__main__:main
+   :prog: gitp
+   :nested: full
 
 
 Contributing

docs/conf.py

@@ -5,5 +5,5 @@
 project = "Git Portfolio"
 author = "Thiago Carvalho D'Ávila"
 copyright = f"{datetime.now().year}, {author}"
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_click"]
 autodoc_typehints = "description"

noxfile.py

@@ -267,7 +267,7 @@ def docs_build(session: Session) -> None:
     """Build the documentation."""
     args = session.posargs or ["docs", "docs/_build"]
     install_package(session)
-    install(session, "sphinx")
+    install(session, "sphinx", "sphinx-click")
 
     build_dir = Path("docs", "_build")
     if build_dir.exists():
@@ -281,7 +281,7 @@ def docs(session: Session) -> None:
     """Build and serve the documentation with live reloading on file changes."""
     args = session.posargs or ["--open-browser", "docs", "docs/_build"]
     install_package(session)
-    install(session, "sphinx", "sphinx-autobuild")
+    install(session, "sphinx", "sphinx-autobuild", "sphinx-click")
 
     build_dir = Path("docs", "_build")
     if build_dir.exists():