This repository has been archived by the owner on Jan 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add the first draft for mkdocs and readthedocs
- Loading branch information
Showing
7 changed files
with
162 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| version: 2 | ||
|
|
||
| mkdocs: | ||
| configuration: mkdocs.yml | ||
| fail_on_warning: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <component name="ProjectRunConfigurationManager"> | ||
| <configuration default="false" name="Saga consumer" type="PythonConfigurationType" factoryName="Python"> | ||
| <module name="melange" /> | ||
| <option name="INTERPRETER_OPTIONS" value="" /> | ||
| <option name="PARENT_ENVS" value="true" /> | ||
| <envs> | ||
| <env name="PYTHONUNBUFFERED" value="1" /> | ||
| </envs> | ||
| <option name="SDK_HOME" value="" /> | ||
| <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/melange/examples/saga_pattern" /> | ||
| <option name="IS_MODULE_SDK" value="true" /> | ||
| <option name="ADD_CONTENT_ROOTS" value="true" /> | ||
| <option name="ADD_SOURCE_ROOTS" value="true" /> | ||
| <EXTENSION ID="DockerComposeSettingsRunConfigurationExtension" commandLine="exec" /> | ||
| <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" /> | ||
| <EXTENSION ID="net.ashald.envfile"> | ||
| <option name="IS_ENABLED" value="false" /> | ||
| <option name="IS_SUBST" value="false" /> | ||
| <option name="IS_PATH_MACRO_SUPPORTED" value="false" /> | ||
| <option name="IS_IGNORE_MISSING_FILES" value="false" /> | ||
| <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" /> | ||
| <ENTRIES> | ||
| <ENTRY IS_ENABLED="true" PARSER="runconfig" /> | ||
| </ENTRIES> | ||
| </EXTENSION> | ||
| <option name="SCRIPT_NAME" value="$PROJECT_DIR$/melange/examples/saga_pattern/app.py" /> | ||
| <option name="PARAMETERS" value="" /> | ||
| <option name="SHOW_COMMAND_LINE" value="false" /> | ||
| <option name="EMULATE_TERMINAL" value="false" /> | ||
| <option name="MODULE_MODE" value="false" /> | ||
| <option name="REDIRECT_INPUT" value="false" /> | ||
| <option name="INPUT_FILE" value="" /> | ||
| <method v="2" /> | ||
| </configuration> | ||
| </component> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <component name="ProjectRunConfigurationManager"> | ||
| <configuration default="false" name="Saga triggerer" type="PythonConfigurationType" factoryName="Python"> | ||
| <module name="melange" /> | ||
| <option name="INTERPRETER_OPTIONS" value="" /> | ||
| <option name="PARENT_ENVS" value="true" /> | ||
| <envs> | ||
| <env name="PYTHONUNBUFFERED" value="1" /> | ||
| </envs> | ||
| <option name="SDK_HOME" value="" /> | ||
| <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/melange/examples/saga_pattern" /> | ||
| <option name="IS_MODULE_SDK" value="true" /> | ||
| <option name="ADD_CONTENT_ROOTS" value="true" /> | ||
| <option name="ADD_SOURCE_ROOTS" value="true" /> | ||
| <EXTENSION ID="DockerComposeSettingsRunConfigurationExtension" commandLine="exec" /> | ||
| <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" /> | ||
| <EXTENSION ID="net.ashald.envfile"> | ||
| <option name="IS_ENABLED" value="false" /> | ||
| <option name="IS_SUBST" value="false" /> | ||
| <option name="IS_PATH_MACRO_SUPPORTED" value="false" /> | ||
| <option name="IS_IGNORE_MISSING_FILES" value="false" /> | ||
| <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" /> | ||
| <ENTRIES> | ||
| <ENTRY IS_ENABLED="true" PARSER="runconfig" /> | ||
| </ENTRIES> | ||
| </EXTENSION> | ||
| <option name="SCRIPT_NAME" value="$PROJECT_DIR$/melange/examples/saga_pattern/saga_triggerer.py" /> | ||
| <option name="PARAMETERS" value="" /> | ||
| <option name="SHOW_COMMAND_LINE" value="false" /> | ||
| <option name="EMULATE_TERMINAL" value="false" /> | ||
| <option name="MODULE_MODE" value="false" /> | ||
| <option name="REDIRECT_INPUT" value="false" /> | ||
| <option name="INPUT_FILE" value="" /> | ||
| <method v="2" /> | ||
| </configuration> | ||
| </component> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| <component name="ProjectRunConfigurationManager"> | ||
| <configuration default="false" name="app" type="PythonConfigurationType" factoryName="Python" nameIsGenerated="true"> | ||
| <module name="melange" /> | ||
| <option name="INTERPRETER_OPTIONS" value="" /> | ||
| <option name="PARENT_ENVS" value="true" /> | ||
| <envs> | ||
| <env name="PYTHONUNBUFFERED" value="1" /> | ||
| </envs> | ||
| <option name="SDK_HOME" value="" /> | ||
| <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/melange/examples/payment_service" /> | ||
| <option name="IS_MODULE_SDK" value="true" /> | ||
| <option name="ADD_CONTENT_ROOTS" value="true" /> | ||
| <option name="ADD_SOURCE_ROOTS" value="true" /> | ||
| <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" /> | ||
| <EXTENSION ID="net.ashald.envfile"> | ||
| <option name="IS_ENABLED" value="false" /> | ||
| <option name="IS_SUBST" value="false" /> | ||
| <option name="IS_PATH_MACRO_SUPPORTED" value="false" /> | ||
| <option name="IS_IGNORE_MISSING_FILES" value="false" /> | ||
| <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" /> | ||
| <ENTRIES> | ||
| <ENTRY IS_ENABLED="true" PARSER="runconfig" /> | ||
| </ENTRIES> | ||
| </EXTENSION> | ||
| <option name="SCRIPT_NAME" value="$PROJECT_DIR$/melange/examples/payment_service/app.py" /> | ||
| <option name="PARAMETERS" value="" /> | ||
| <option name="SHOW_COMMAND_LINE" value="false" /> | ||
| <option name="EMULATE_TERMINAL" value="false" /> | ||
| <option name="MODULE_MODE" value="false" /> | ||
| <option name="REDIRECT_INPUT" value="false" /> | ||
| <option name="INPUT_FILE" value="" /> | ||
| <method v="2" /> | ||
| </configuration> | ||
| </component> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <component name="ProjectRunConfigurationManager"> | ||
| <configuration default="false" name="triggerer" type="PythonConfigurationType" factoryName="Python" nameIsGenerated="true"> | ||
| <module name="melange" /> | ||
| <option name="INTERPRETER_OPTIONS" value="" /> | ||
| <option name="PARENT_ENVS" value="true" /> | ||
| <envs> | ||
| <env name="PYTHONUNBUFFERED" value="1" /> | ||
| </envs> | ||
| <option name="SDK_HOME" value="" /> | ||
| <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/melange/examples" /> | ||
| <option name="IS_MODULE_SDK" value="true" /> | ||
| <option name="ADD_CONTENT_ROOTS" value="true" /> | ||
| <option name="ADD_SOURCE_ROOTS" value="true" /> | ||
| <EXTENSION ID="DockerComposeSettingsRunConfigurationExtension" commandLine="exec" /> | ||
| <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" /> | ||
| <EXTENSION ID="net.ashald.envfile"> | ||
| <option name="IS_ENABLED" value="false" /> | ||
| <option name="IS_SUBST" value="false" /> | ||
| <option name="IS_PATH_MACRO_SUPPORTED" value="false" /> | ||
| <option name="IS_IGNORE_MISSING_FILES" value="false" /> | ||
| <option name="IS_ENABLE_EXPERIMENTAL_INTEGRATIONS" value="false" /> | ||
| <ENTRIES> | ||
| <ENTRY IS_ENABLED="true" PARSER="runconfig" /> | ||
| </ENTRIES> | ||
| </EXTENSION> | ||
| <option name="SCRIPT_NAME" value="$PROJECT_DIR$/melange/examples/payment_service/triggerer.py" /> | ||
| <option name="PARAMETERS" value="" /> | ||
| <option name="SHOW_COMMAND_LINE" value="false" /> | ||
| <option name="EMULATE_TERMINAL" value="false" /> | ||
| <option name="MODULE_MODE" value="false" /> | ||
| <option name="REDIRECT_INPUT" value="false" /> | ||
| <option name="INPUT_FILE" value="" /> | ||
| <method v="2" /> | ||
| </configuration> | ||
| </component> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Welcome to MkDocs | ||
|
|
||
| For full documentation visit [mkdocs.org](https://www.mkdocs.org). | ||
|
|
||
| ## Commands | ||
|
|
||
| * `mkdocs new [dir-name]` - Create a new project. | ||
| * `mkdocs serve` - Start the live-reloading docs server. | ||
| * `mkdocs build` - Build the documentation site. | ||
| * `mkdocs -h` - Print help message and exit. | ||
|
|
||
| ## Project layout | ||
|
|
||
| mkdocs.yml # The configuration file. | ||
| docs/ | ||
| index.md # The documentation homepage. | ||
| ... # Other markdown pages, images and other files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| site_name: Melange |