adding initial docs

This commit is contained in:
2021-09-27 21:19:28 +01:00
parent a73d7b74a4
commit cbb8a7e237
9 changed files with 261 additions and 18 deletions

View File

@@ -4,37 +4,36 @@ use_directory_urls: false
nav:
- Documentation:
- Welcome: index.md
# - Installation: documentation/installation.md
# - Usage: documentation/usage.md
# - Comments and Caveats:
# - Introduction: comments_caveats/introduction.md
# - Time limit: comments_caveats/time_limit.md
# - Third party libraries: comments_caveats/third_party_libraries.md
# - Areas of improvement and comments: comments_caveats/area_of_improvement_comments.md
# - Similar names algorithm: comments_caveats/similar_names.md
# - Reference:
# - deduplicator.main: reference/api_documentation_main.md
# - Changelog: changelog/changelog.md
- Installation: documentation/installation.md
- Usage: documentation/usage.md
- Discussion:
- Introduction: discussion/introduction.md
- Data Exploration Report: discussion/exploration.md
- Cleaning: discussion/cleaning.md
- Approach: discussion/approach.md
- Data Exploration Report: pandas-profiling/report.html
theme:
name: material
palette:
primary: indigo
accent: blue
feature:
tabs: true
features:
navigation.tabs: true
markdown_extensions:
- admonition
- codehilite:
guess_lang: true
- toc:
permalink: true
- pymdownx.highlight
- pymdownx.superfences
# - pymdownx.arithmatex:
# generic: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.arithmatex:
generic: true
plugins:
- search:
lang: en
extra_javascript:
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js