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

📚 docs(introduction.rst): add introduction #16

Merged
merged 1 commit into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/source/_pages/introduction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
###############
Introduction 📈
###############

``Qt`` Graphics View Framework
==============================

The `Qt Graphics View Framework`_ consists of the following hierarchy::

View -> Scene -> Item

where ``Views`` are scroll area widgets for observing ``Scenes`` and ``Scenes`` contain ``Items``. Each object has its own coordinate system.

.. list-table::

* - .. figure:: ../_resources/img/item_coordinates.png

**Item Coordinates**

-
-

.. _`Qt Graphics View Framework`:
https://doc.qt.io/qt-6/graphicsview.html
Binary file added docs/source/_resources/img/item_coordinates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#qt-graphics-view-framework .table td {
border-top-width: 0px !important;
}
10 changes: 4 additions & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@
# -- General configuration --------------------------------------------------------------

# Paths are relative to ``source``
# templates_path = ['_templates']
# html_static_path = ['_static']
html_static_path = ['_static']

source_suffix = '.rst'
master_doc = 'index'
Expand All @@ -68,10 +67,9 @@

html_theme = 'sphinx_book_theme'
# html_logo = r'./_resources/img/qtpygraph_logo.png'
# html_css_files = [
# 'css/custom.css',
# ]
# html_style = 'css/style.css'
html_css_files = [
'css/custom.css',
]

# String appended to project name with hyphen in ``<title>`` tag of individual pages and
# used in the navigation bar as the “topmost” element. It defaults to '<project>
Expand Down
6 changes: 6 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ A pythonic interface to the ``Qt`` Graphics View Framework using ``qtpy``.
:maxdepth: 2
:caption: Home Page

.. toctree::
:maxdepth: 2
:caption: Introduction

_pages/introduction

.. toctree::
:maxdepth: 2
:caption: Contributing
Expand Down
Loading