Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation about packaging theme to use modern tools #3088

Open
sumau opened this issue Jan 2, 2023 · 1 comment
Open

Update documentation about packaging theme to use modern tools #3088

sumau opened this issue Jan 2, 2023 · 1 comment

Comments

@sumau
Copy link

sumau commented Jan 2, 2023

The documentation about packaging theme refers to somewhat outdated tools and practices.

I was wondering if you could update the documentation to use pyproject.toml and perhaps setup.cfg:
https://packaging.python.org/en/latest/tutorials/packaging-projects/

I have an example pyproject.toml file:

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

And example setup.cfg:

[metadata]
name = mkdocs-<theme-name>
version = attr: <theme_name>.__version__
author = 
author_email = 
url = 
description =  
long_description = file: README.md
long_description_content_type = text/markdown
keywords = mkdocs
license = MIT
classifiers =
    Programming Language :: Python :: 3
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent

[options]
packages = find:
include_package_data = True
zip_safe=False
install_requires =
	mkdocs-<theme-parent>

[options.entry_points]
mkdocs.themes =
	<theme_name> = <theme_name>

[options.extras_require]
docs =
	markdown-include
	mkdocs

[options.package_data]
<theme_name> =
    *.html
     mkdocs_theme.yml
@ultrabug
Copy link
Member

ultrabug commented Mar 3, 2023

Hi @sumau ; it would be useful if you could propose that change through a PR maybe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants