Skip to content

Commit

Permalink
docs: getting started installation info help
Browse files Browse the repository at this point in the history
docs: license and changelog pages

docs(build): change logo color and favicon

removing markdown parser `.txt` for no build docs for
`requirements-dev.txt` files
  • Loading branch information
mdsanima committed Apr 12, 2022
1 parent e1ff694 commit cba3381
Show file tree
Hide file tree
Showing 6 changed files with 263 additions and 67 deletions.
2 changes: 1 addition & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
```{include} ../../CHANGELOG.md
```{include} ../CHANGELOG.md
```
5 changes: 2 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@

# markdown parser
source_suffix = {
".txt": "markdown",
".md": "markdown",
}

Expand All @@ -49,8 +48,8 @@

# theme options
html_theme = "furo"
html_logo = "_static/logo/filled/svg/logo_mdsanima_default_14-lime.svg"
html_favicon = "_static/logo/squere/png/logo_mdsanima_default_14-lime_1x.png"
html_logo = "_static/logo/filled/svg/logo_mdsanima_default_02-sky.svg"
html_favicon = "_static/logo/squere/png/logo_mdsanima_default_02-sky_1x.png"

# html options
html_show_sphinx = True
Expand Down
56 changes: 32 additions & 24 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# MDSANIMA DEVELOPMENT

Welcome to **MDSANIMA-DEV** documentation site.
Welcome in **MDSANIMA-DEV** documentation site.

```{include} ../README.md
:start-after: <!-- start info-mdsanima-dev -->
:end-before: <!-- end info-mdsanima-dev -->
```

![mdsanima-dev-python-show-gif](_images/gif/mdsanima_dev_python_show.gif)

This organization mainly deals with *Python* programming. Sometimes we also
coding in other languages like *JavaScript*, *HTML*, *Bash* and *PowerShell*
Expand All @@ -11,48 +18,49 @@ and *Machine Learning*. We developing apps and plugins as containers
in *Docker Compose* for easy deployment. We know *Linux* with better security.
Every day we learn something new.

```{include} ../README.md
```{toctree}
:hidden:
installation
```

## Python Modules

This is all modules include of this package.

```{eval-rst}
.. toctree::
:maxdepth: 3
:caption: Python Modules
```{toctree}
:maxdepth: 3
:caption: Python Modules
modules/colors
modules/converts
modules/emoji
modules/table
modules/tools
module-colors
module-converts
module-emoji
module-table
module-tools
```

## Command Line

This shell console script options allowing you to converting selected function
directly in command line in the terminal window like *Bash*, *zsh*, *PowerShell*
and more.
directly in command line in the terminal window like *bash*, *zsh*,
*PowerShell* and more.

```{eval-rst}
.. toctree::
:maxdepth: 3
:caption: Command Line
```{toctree}
:maxdepth: 3
:caption: Command Line
shell/converts
shell-converts
```

## Development

Helping instruction for development workflow and release deployment.

```{eval-rst}
.. toctree::
:maxdepth: 2
:caption: Development
```{toctree}
:maxdepth: 2
:caption: Development
devs/workflow
devs/changelog
workflow
changelog
license
```
41 changes: 41 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# GETTING STARTED

```{include} ../README.md
:start-after: <!-- start help-started -->
:end-before: <!-- end help-started -->
```

## Installation

```{include} ../README.md
:start-after: <!-- start help-installation -->
:end-before: <!-- end help-installation -->
```

### Using `PyPI`

```{include} ../README.md
:start-after: <!-- start help-using-pypi -->
:end-before: <!-- end help-using-pypi -->
```

### Using `Setup`

```{include} ../README.md
:start-after: <!-- start help-using-setup -->
:end-before: <!-- end help-using-setup -->
```

### Using `Wheel`

```{include} ../README.md
:start-after: <!-- start help-using-wheel -->
:end-before: <!-- end help-using-wheel -->
```

### On `virtualenv`

```{include} ../README.md
:start-after: <!-- start help-on-virtualenv -->
:end-before: <!-- end help-on-virtualenv -->
```
4 changes: 4 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# LICENSE

```{include} ../LICENSE
```

0 comments on commit cba3381

Please sign in to comment.