diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..9e44b2c --- /dev/null +++ b/codecov.yml @@ -0,0 +1,9 @@ +coverage: + status: + project: + default: + target: 90% + threshold: 2% # Up to 2% drop/fluctuation is OK + patch: + default: + threshold: 2% diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/api_reference.md b/docs/api_reference.md new file mode 100644 index 0000000..fa8ac39 --- /dev/null +++ b/docs/api_reference.md @@ -0,0 +1,8 @@ +# API Reference + +::: paperscraper + options: + show_if_no_docstring: true + show_submodules: true + filters: + - "!^_[^_]" diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/docs/index.md @@ -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. diff --git a/docs/favicon.png b/docs/favicon.png new file mode 100644 index 0000000..3409de5 Binary files /dev/null and b/docs/favicon.png differ diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..115e404 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,123 @@ +site_name: Paperscraper +site_description: Documentation for the paperscraper python package +# site_url : +# Repository +repo_name: jannisborn/paperscraper +repo_url: https://github.com/jannisborn/paperscraper +edit_uri: edit/main/docs/ + +# Theme +theme: + name: material + font: + text: IBM Plex Sans + code: IBM Plex Mono + logo: favicon.png + favicon: favicon.png + features: + - content.code.annotate + # - content.tabs.link + - content.tooltips + # - header.autohide + # - navigation.expand + - navigation.indexes + # - navigation.instant + # - navigation.sections + # - navigation.tabs + # - navigation.tabs.sticky + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow + # - toc.integrate + + palette: + - scheme: default + primary: black + accent: blue + toggle: + icon: material/toggle-switch + name: Switch to dark mode + - scheme: slate + primary: black + accent: blue + toggle: + icon: material/toggle-switch-off-outline + name: Switch to light mode + language: en + +nav: + - Home: README.md + - API Reference: + - Paperscraper: api_reference.md + +# Copyright +copyright: MIT License + +# Customization +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/jannisborn/paperscraper + generator: false + +# Plugins +plugins: + - search + - mkdocstrings: + default_handler: python + handlers: + python: + options: + render_typehint_in_signature: true + show_root_heading: true + show_signature_annotations: true + show_source: false + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - md_in_html + - abbr + - admonition + - attr_list + - def_list + - footnotes + - meta + - toc: + permalink: true + - pymdownx.arithmatex: + generic: true + - pymdownx.betterem: + smart_enable: all + - pymdownx.caret + - pymdownx.critic + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - pymdownx.keys + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.snippets: + check_paths: true + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + +extra_css: + - css/termynal.css + - css/custom.css +extra_javascript: + - js/termynal.js + - js/custom.js \ No newline at end of file