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

Structure an introductory document for QGIS documentation #9642

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,8 @@ def calculate_tx_slug(filepath):
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('docs/about/index', 'aboutQGIS.tex',
f'About QGIS {version}', u'QGIS Project', 'manual'),
('docs/user_manual/index', 'DesktopUserGuide.tex',
f'QGIS Desktop {version} User Guide', u'QGIS Project', 'manual'),
('docs/server_manual/index', 'ServerUserGuide.tex',
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions docs/about/license/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

**********************************
Complying with Licenses
**********************************

.. toctree::
:maxdepth: 1

GNU_GPL
GNU_FDL


QGIS is created and distributed under the :ref:`GNU General Public License (GPL) <gpl_appendix>`
and the current documentation is provided under the :ref:`GNU Free Documentation License <gfl_appendix>`,
Version 1.3 or any later version.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@
Preamble
********

This is the user guide for the geographical information system (GIS)
Welcome to the documentation of the geographical information system (GIS)
software QGIS.
QGIS is subject to the GNU General Public License.
More information is available on the QGIS homepage,
https://www.qgis.org.
QGIS is subject to the GNU General Public License version 2, or any later version.
More information is available on the `QGIS website <https://www.qgis.org/license>`_.

The contents of this document have been written and verified to the
best of the knowledge of the authors and editors.
Expand Down Expand Up @@ -41,7 +40,7 @@ The list of the persons who have contributed with writing, reviewing
and translating the following documentation is available
at :ref:`doc_contributors`.

Copyright (c) 2004 - 2020 QGIS Development Team
Copyright (c) 2004 - 2025 QGIS Development Team

**Internet:** https://www.qgis.org

Expand Down
12 changes: 12 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,18 @@ you can download for offline reading. They are accessible from the

Please have a look into one of the documents below.

.. toctree::
:maxdepth: 1
:caption: About QGIS

about/preamble
about/foreword
about/conventions
about/features
about/help_and_support
about/contributors
about/license/index

.. toctree::
:maxdepth: 2
:caption: For Users
Expand Down
2 changes: 0 additions & 2 deletions docs/user_manual/appendices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
.. toctree::
:maxdepth: 2

GNU_GPL
GNU_FDL
qgis_file_formats
qgis_r_syntax
qgis_desktop_network_connections
6 changes: 0 additions & 6 deletions docs/user_manual/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ QGIS User Guide
:maxdepth: 2
:numbered: 4

preamble/preamble
preamble/foreword
preamble/conventions
preamble/features
introduction/getting_started
introduction/project_files
introduction/qgis_gui
Expand All @@ -37,7 +33,5 @@ QGIS User Guide
processing/index
processing_algs/index
plugins/index
preamble/help_and_support
preamble/contributors
appendices/index
literature_web/literature_and_web_references
7 changes: 7 additions & 0 deletions redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ docs/training_manual/introduction/preparation.rst docs/training_manual/basic_map

# User manual
docs/user_manual/appendices/appendices.rst docs/user_manual/appendices/index.rst
docs/user_manual/appendices/GNU_FDL.rst docs/about/license/GNU_FDL.rst
docs/user_manual/appendices/GNU_GPL.rst docs/about/license/GNU_GPL.rst
docs/user_manual/plugins/core_plugins.rst docs/user_manual/plugins/core_plugins/index.rst
docs/user_manual/plugins/core_plugins/plugins_georeferencer.rst docs/user_manual/working_with_raster/georeferencer.rst
docs/user_manual/plugins/plugins_db_manager.rst docs/user_manual/plugins/core_plugins/plugins_db_manager.rst
Expand All @@ -39,6 +41,11 @@ docs/user_manual/plugins/plugins_spatial_query.rst docs/user_manual/processing_a
docs/user_manual/plugins/plugins_spit.rst docs/user_manual/plugins/core_plugins/plugins_db_manager.rst
docs/user_manual/plugins/plugins_topology_checker.rst docs/user_manual/plugins/core_plugins/plugins_topology_checker.rst

docs/user_manual/preamble/conventions.rst docs/about/conventions.rst
docs/user_manual/preamble/features.rst docs/about/features.rst
docs/user_manual/preamble/foreword.rst docs/about/foreword.rst
docs/user_manual/preamble/help_and_support.rst docs/about/help_and_support.rst
docs/user_manual/preamble/preamble.rst docs/about/preamble.rst
docs/user_manual/preamble/whats_new.rst docs/user_manual/preamble/preamble.rst
docs/user_manual/processing_algs/qgis/qgis_algs_include.rst docs/user_manual/processing_algs/algs_include.rst
docs/user_manual/qgis_browser/qgis_browser.rst docs/user_manual/introduction/browser.rst
Expand Down
Loading