Merge pull request #494 from sanders41/docs

Add option to include docs

Author: sanders41

README.md

@@ -34,6 +34,16 @@ Dev packages:
 - [justfile](https://github.com/casey/just) for running commands (to use this you will need to
   install just)
 
+## Docs
+
+If you chose to include docs then additional dev packages will be included for docs.
+
+- [mkdocs](index_md) for creating the docs
+- [mkdocs-material](index_md) for theming the docs
+- [mkdocstrings](index_md) for automatically creating API docs
+
+Additionally the `pypi_publish.yml` workflow will also be setup to deploy the doc on release.
+
 ## Installation
 
 Install with `cargo`:
@@ -152,6 +162,42 @@ python-project create -s
   Choosing yes will setup CI to run tests on Linux, Mac, and Windows. If no is chosen tests will
   only run on Linux in CI.
 
+- Include Docs
+
+  Choosing yes will add additional packages and base setup for creating documents with mkdocs.
+
+- Docs Site Name
+
+  This quesion will only show if you chose `yes` for `Include Docs`. This value sets the site name
+  field for mkdocs.
+
+- Docs Site Description
+
+  This quesion will only show if you chose `yes` for `Include Docs`. This value provides a
+  a description of the repo to use in the docs.
+
+- Docs Site URL
+
+  This quesion will only show if you chose `yes` for `Include Docs`. This is the URL where the docs
+  will be hosted.
+
+- Docs Locale
+
+  This quesion will only show if you chose `yes` for `Include Docs`, and controls the language of
+  the docs.
+
+- Repo Name
+
+  This quesion will only show if you chose `yes` for `Include Docs`. This is the name of the repo
+  the docs are referencing. For example in this repository the repo name would be
+  `sanders41/python-project-generator`.
+
+- Repo URL
+
+  This quesion will only show if you chose `yes` for `Include Docs`. This is URL for the repo the
+  docs are referencing. For example in this repository the repo url would be
+  `https://github.com/sanders41/python-project-generator`
+
 After running the generator a new directory will be created with the name you used for the
 `Project Slug`. Change to this directory then install the python packages and pre-commit hooks.
 

src/cli.rs

@@ -99,6 +99,9 @@ pub enum Param {
     /// Save a default value for Use Multi OS CI
     UseMultiOsCi { value: BooleanChoice },
 
+    /// Setup docs
+    IncludeDocs { value: BooleanChoice },
+
     /// Save a default value for Download Latest Packages
     DownloadLatestPackages { value: BooleanChoice },
 

src/config.rs

@@ -30,6 +30,7 @@ pub struct Config {
     pub use_continuous_deployment: Option<bool>,
     pub use_release_drafter: Option<bool>,
     pub use_multi_os_ci: Option<bool>,
+    pub include_docs: Option<bool>,
     pub download_latest_packages: Option<bool>,
 }
 
@@ -270,6 +271,17 @@ impl Config {
         Ok(())
     }
 
+    pub fn save_include_docs(value: bool) -> Result<()> {
+        if let Ok(mut config) = Config::load_config() {
+            config.include_docs = Some(value);
+            config.save()?;
+        } else {
+            raise_error()?;
+        }
+
+        Ok(())
+    }
+
     pub fn save_download_latest_packages(value: bool) -> Result<()> {
         if let Ok(mut config) = Config::load_config() {
             config.download_latest_packages = Some(value);
@@ -320,6 +332,7 @@ impl Config {
         );
         print_config_value("Use Release Drafter", &config.use_release_drafter);
         print_config_value("Use Multi OS CI", &config.use_multi_os_ci);
+        print_config_value("Include Docs", &config.include_docs);
         print_config_value("Download Latest Packages", &config.download_latest_packages);
     }
 }