QT/qt-material
1
0
Fork 0
mirror of https://github.com/UN-GCPDS/qt-material.git synced 2025-01-13 16:42:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Yeison 2020-12-05 21:48:07 -05:00
parent bd4bc09a4b
commit ec9a94e024
3 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Makefile
View File

@ -22,7 +22,7 @@ help:
buildapi:
sphinx-apidoc -fMeET -o source/_modules ../pyside_material
sphinx-apidoc -fMeET -o source/_modules ../qt_material
#mkdir -p source/_notebooks/images

12
docs/source/conf.py
View File

@ -20,7 +20,7 @@ sys.path.insert(0, os.path.abspath('exts'))
# -- Project information -----------------------------------------------------
project = 'PySide Material'
project = 'Qt Material'
copyright = '2019, Yeison Cardona'
author = 'Yeison Cardona'
@ -149,7 +149,7 @@ html_sidebars = {
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'PySideMaterialdoc'
htmlhelp_basename = 'QtMaterialdoc'
# -- Options for LaTeX output ------------------------------------------------
@ -176,7 +176,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'PySideMaterial.tex', 'PySide Material Documentation',
(master_doc, 'QtMaterial.tex', 'Qt Material Documentation',
'Yeison Cardona', 'manual'),
]
@ -186,7 +186,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pysidematerial', 'PySide Material Documentation',
(master_doc, 'qtmaterial', 'Qt Material Documentation',
[author], 1)
]
@ -197,8 +197,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'PySideMaterial', 'PySide Material Documentation',
author, 'PySideMaterial', 'One line description of project.',
(master_doc, 'QtMaterial', 'Qt Material Documentation',
author, 'QtMaterial', 'One line description of project.',
'Miscellaneous'),
]

34
docs/source/index.rst
View File

@ -1,12 +1,13 @@
.. PySide Material documentation master file, created by
.. Qt Material documentation master file, created by
sphinx-quickstart on Wed Aug 7 20:30:20 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
PySide Material
===============
Qt Material
===========
This is another stylesheet for PySide, this time looks like Material Design.
This is another stylesheet for PySide2 and PyQt5, this time looks like Material
Design (close enough).
|GitHub top language| |PyPI - License| |PyPI| |PyPI - Status| |PyPI -
Python Version| |GitHub last commit| |CodeFactor Grade| |Documentation
@ -28,7 +29,7 @@ Install
.. code:: bash
pip install pyside-material
pip install qt-material
Usage
@ -38,7 +39,8 @@ Usage
import sys
from PySide2 import QtWidgets
from pyside_material import apply_stylesheet
# from PyQt5 import QtWidgets
from qt_material import apply_stylesheet
# create the application and the main window
app = QtWidgets.QApplication(sys.argv)
@ -57,7 +59,7 @@ Themes
.. code:: python
from pyside_material import list_themes
from qt_material import list_themes
list_themes()
@ -128,15 +130,15 @@ Light will need to add `light_secondary` argument as `True`.
.. |GitHub top language| image:: https://img.shields.io/github/languages/top/un-gcpds/pyside-material
.. |PyPI - License| image:: https://img.shields.io/pypi/l/pyside-material
.. |PyPI| image:: https://img.shields.io/pypi/v/pyside-material
.. |PyPI - Status| image:: https://img.shields.io/pypi/status/pyside-material
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/pyside-material
.. |GitHub last commit| image:: https://img.shields.io/github/last-commit/un-gcpds/pyside-material
.. |CodeFactor Grade| image:: https://img.shields.io/codefactor/grade/github/UN-GCPDS/pyside-material
.. |Documentation Status| image:: https://readthedocs.org/projects/pyside-material/badge/?version=latest
:target: https://pyside-material.readthedocs.io/en/latest/?badge=latest
.. |GitHub top language| image:: https://img.shields.io/github/languages/top/un-gcpds/qt-material
.. |PyPI - License| image:: https://img.shields.io/pypi/l/qt-material
.. |PyPI| image:: https://img.shields.io/pypi/v/qt-material
.. |PyPI - Status| image:: https://img.shields.io/pypi/status/qt-material
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/qt-material
.. |GitHub last commit| image:: https://img.shields.io/github/last-commit/un-gcpds/qt-material
.. |CodeFactor Grade| image:: https://img.shields.io/codefactor/grade/github/UN-GCPDS/qt-material
.. |Documentation Status| image:: https://readthedocs.org/projects/qt-material/badge/?version=latest
:target: https://qt-material.readthedocs.io/en/latest/?badge=latest