Skip to content

Commit

Permalink
feat: update python-mkdocs to 1.5.3+dfsg-1
Browse files Browse the repository at this point in the history
  • Loading branch information
deepin-community-bot[bot] authored and xzl01 committed Jun 28, 2024
1 parent 79a03e9 commit 063c1c1
Show file tree
Hide file tree
Showing 211 changed files with 26,746 additions and 8,375 deletions.
11 changes: 11 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
codecov:
ci:
- "!ci.appveyor.com"
coverage:
status:
patch: false
project:
default:
target: 90

comment: false
2 changes: 2 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[report]
show_missing = True
42 changes: 42 additions & 0 deletions .csslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
--exclude-list = mkdocs/themes/mkdocs/css/bootstrap.min.css,
mkdocs/themes/mkdocs/css/font-awesome.min.css,
mkdocs/themes/mkdocs/css/highlight.css,
mkdocs/themes/readthedocs/css/theme.css
--errors = known-properties,
box-sizing,
outline-none,
bulletproof-font-face,
compatible-vendor-prefixes,
errors,
duplicate-background-images,
duplicate-properties,
empty-rules,
selector-max-approaching,
gradients,
floats,
font-faces,
font-sizes,
shorthand,
import,
import-ie-limit,
text-indent,
rules-count,
regex-selectors,
selector-max,
selector-newline,
star-property-hack,
underscore-property-hack,
universal-selector,
unqualified-attributes,
vendor-prefix,
zero-units,
overqualified-elements,
unique-headings,
qualified-headings,
ids,
display-property-grouping,
fallback-colors,
box-model,
important,
adjoining-classes
--ignore = order-alphabetical
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# editorconfig.org

root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.js]
indent_size = 2

[*.md]
trim_trailing_whitespace = false
10 changes: 10 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
mkdocs/contrib/search/lunr-language/** linguist-vendored
mkdocs/themes/mkdocs/js/** linguist-vendored
mkdocs/themes/mkdocs/js/base.js linguist-vendored=false
mkdocs/themes/mkdocs/css/** linguist-vendored
mkdocs/themes/mkdocs/css/base.css linguist-vendored=false
mkdocs/themes/readthedocs/js/** linguist-vendored
mkdocs/themes/readthedocs/js/theme.js linguist-vendored=false
mkdocs/themes/readthedocs/css/** linguist-vendored
mkdocs/themes/readthedocs/css/theme_extra.css linguist-vendored=false
docs/img/plugin-events.svg linguist-generated
70 changes: 70 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
node_modules/
parts/
sdist/
var/
package*.json
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo

# Scrapy stuff:
.scrapy

# PyBuilder
target/

# IPython Notebook
.ipynb_checkpoints

# pyenv
.python-version

# virtualenv
venv/
ENV/

# MkDocs documentation
site*/
9 changes: 9 additions & 0 deletions .jshintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
mkdocs/themes/**/js/jquery-**.min.js
mkdocs/themes/mkdocs/js/highlight.pack.js
mkdocs/themes/mkdocs/js/bootstrap.min.js
mkdocs/themes/mkdocs/js/modernizr-**.min.js
mkdocs/themes/readthedocs/js/theme.js
mkdocs/themes/readthedocs/js/html5shiv.min.js
mkdocs/contrib/search/templates/search/lunr.js
mkdocs/contrib/search/lunr-language/lunr.**.js
mkdocs/contrib/search/lunr-language/tinyseg.js
24 changes: 24 additions & 0 deletions .markdownlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
// Enable all markdownlint rules
"default": true,

// Disable line length check
"MD013": false,

// Set Ordered list item prefix to "ordered" (use 1. 2. 3. not 1. 1. 1.)
"MD029": { "style": "ordered" },

"MD030": { "ul_multi": 3, "ol_multi": 2 },

// Set list indent level to 4 which Python-Markdown requires
"MD007": { "indent": 4 },

// Code block style
"MD046": { "style": "fenced" },

// Multiple headings with the same title
"MD024": { "siblings_only": true },

// Allow inline HTML
"MD033": false
}
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright © 2014, Tom Christie. All rights reserved.
Copyright © 2014-present, Tom Christie. All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
Expand Down
5 changes: 0 additions & 5 deletions MANIFEST.in

This file was deleted.

84 changes: 62 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,79 @@
# MkDocs

Project documentation with Markdown.

---
> *Project documentation with Markdown*
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Build Status][travis-image]][travis-link]
[![Windows Build Status][appveyor-image]][appveyor-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]
[![Landscale Code Health][landscape-image]][landscape-link]

- View the [MkDocs documentation][mkdocs].
- Project [release notes][release-notes].
- Visit the [MkDocs wiki](https://github.com/mkdocs/mkdocs/wiki) for community
resources, including third party themes and a list of MkDocs users.
- IRC channel: `#mkdocs` on freenode.
- Discussions and support: <https://groups.google.com/forum/#!forum/mkdocs>
MkDocs is a **fast**, **simple** and **downright gorgeous** static site
generator that's geared towards building project documentation. Documentation
source files are written in Markdown, and configured with a single YAML
configuration file. It is designed to be easy to use and can be extended with
third-party themes, plugins, and Markdown extensions.

Please see the [Documentation][mkdocs] for an introductory tutorial and a full
user guide.

## Features

- Build static HTML files from Markdown files.
- Use Plugins and Markdown Extensions to enhance MkDocs.
- Use the built-in themes, third party themes or create your own.
- Publish your documentation anywhere that static files can be served.
- Much more!

## Support

If you need help with MkDocs, do not hesitate to get in contact with us!

- For questions and high-level discussions, use **[Discussions]** on GitHub.
- For small questions, a good alternative is the **[Chat room]** on
Gitter/Matrix.
- To report a bug or make a feature request, open an **[Issue]** on GitHub.

Please note that we may only provide
support for problems/questions regarding core features of MkDocs. Any
questions or bug reports about features of third-party themes, plugins,
extensions or similar should be made to their respective projects.
But, such questions are *not* banned from the [chat room].

Make sure to stick around to answer some questions as well!

## Links

- [Official Documentation][mkdocs]
- [Latest Release Notes][release-notes]
- [Catalog of third-party plugins, themes and recipes][catalog]

## Contributing to MkDocs

The MkDocs project welcomes, and depends on, contributions from developers and
users in the open source community. Please see the [Contributing Guide] for
information on how you can help.

## Code of Conduct

Everyone interacting in the MkDocs project's codebases, issue trackers, chat
rooms, and mailing lists is expected to follow the [PyPA Code of Conduct].
Everyone interacting in the MkDocs project's codebases, issue trackers, and
discussion forums is expected to follow the [PyPA Code of Conduct].

[appveyor-image]: https://img.shields.io/appveyor/ci/d0ugal/mkdocs/master.svg
[appveyor-link]: https://ci.appveyor.com/project/d0ugal/mkdocs
<!-- Badges -->
[codecov-image]: https://codecov.io/github/mkdocs/mkdocs/coverage.svg?branch=master
[codecov-link]: https://codecov.io/github/mkdocs/mkdocs?branch=master
[landscape-image]: https://landscape.io/github/mkdocs/mkdocs/master/landscape.svg?style=flat
[landscape-link]: https://landscape.io/github/mkdocs/mkdocs/master
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs.svg
[pypi-v-link]: https://pypi.org/project/mkdocs/
[travis-image]: https://img.shields.io/travis/mkdocs/mkdocs/master.svg
[travis-link]: https://travis-ci.org/mkdocs/mkdocs

[GHAction-image]: https://github.com/mkdocs/mkdocs/workflows/CI/badge.svg?branch=master&event=push
[GHAction-link]: https://github.com/mkdocs/mkdocs/actions?query=event%3Apush+branch%3Amaster
<!-- Links -->
[mkdocs]: https://www.mkdocs.org
[Issue]: https://github.com/mkdocs/mkdocs/issues
[Discussions]: https://github.com/mkdocs/mkdocs/discussions
[Chat room]: https://gitter.im/mkdocs/community
[release-notes]: https://www.mkdocs.org/about/release-notes/

[Contributing Guide]: https://www.mkdocs.org/about/contributing/
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
[catalog]: https://github.com/mkdocs/catalog

## License

[BSD-2-Clause](https://github.com/mkdocs/mkdocs/blob/master/LICENSE)
25 changes: 0 additions & 25 deletions appveyor.yml

This file was deleted.

44 changes: 44 additions & 0 deletions debian/README.source
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
This package is maintained with git-buildpackage(1). It follows DEP-14 for
branch naming (e.g. using debian/master for the current version in Debian
unstable due Debian Python team policy).

It uses pristine-tar(1) to store enough information in git to generate bit
identical tarballs when building the package without having downloaded an
upstream tarball first.

When working with patches it is recommended to use "gbp pq import" to import
the patches, modify the source and then use "gbp pq export --commit" to commit
the modifications.

The changelog is generated using "gbp dch" so if you submit any changes don't
bother to add changelog entries but rather provide a nice git commit message
that can then end up in the changelog.

It is recommended to build the package with pbuilder using:

gbp buildpackage --git-pbuilder

For information on how to set up a pbuilder environment see the git-pbuilder(1)
manpage. In short:

DIST=sid git-pbuilder create
gbp clone https://salsa.debian.org/python-team/packages/python-mkdocs.git
cd python-mkdocs
gbp buildpackage --git-pbuilder

The mkdocs source of 1.3.0 comes with new included web fonts from the
readthedocs inclusion.
Namely these are

Roboto-Slab-Bold.{woff,woff2}
Roboto-Slab-Regular.{woff,woff2}
lato-bold-italic.{woff,woff2}
lato-bold-regular.{woff,woff2}
lato-normal{,-italic}.{woff,woff2}
lato-normal{,-regular}.{woff,woff2}

These fonts haven't been packaged yet in Debian while writing.
The autopkgtest should be updated once these font files are available as an
package to check if the files are linked to the font package.

-- Carsten Schoenert <[email protected]> Tue, 29 Mar 2022 08:47:00 +0200
Loading

0 comments on commit 063c1c1

Please sign in to comment.