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

Split docs by user/contributor at top level #691

Merged
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
1 change: 0 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
"sphinx_selective_exclude.eager_only",
"sphinx_selective_exclude.search_auto_exclude",
"sphinx_selective_exclude.modindex_exclude",
"toctree_select_builder",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
11 changes: 0 additions & 11 deletions doc/contributor-how-to/index.rst

This file was deleted.

11 changes: 11 additions & 0 deletions doc/contributor/discussion/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _contributor-discussion:

==========
Discussion
==========

.. toctree::
:maxdepth: 1
:glob:

./*
11 changes: 11 additions & 0 deletions doc/contributor/how-to/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _contributor-how-to:

=============
How-to guides
=============

.. toctree::
:maxdepth: 1
:glob:

./*
Original file line number Diff line number Diff line change
Expand Up @@ -53,21 +53,6 @@ one might intuitively expect. Specifically, it isn't capable of creating conditi
filtered `toctrees`. Because of this insufficiency, we're employing two nonstandard
methods in `doc/index.rst` to deselect items from PDF docs:

* Our custom `.. toctree-select-builder::` directive, defined in
`doc/sphinx-ext/toctree_select_builder.py`, is a customized `toctree` directive which
enables filtering its contents. If a prefix is present, that entry will only be kept
if the prefix matches the name of the current builder.

```rst
.. toctree-select-builder::
:name: Mixed content
:caption: Mixed content

always/shown/document
:html:html/only/document
:latex:pdf/only/document
```

* The package
[sphinx-selective-exclude](https://pypi.org/project/sphinx-selective-exclude/)
enhances the behavior of `.. only::` to more intuitively select content during the
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions doc/contributor/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _contributor-reference:

=========
Reference
=========

.. toctree::
:maxdepth: 1
:glob:

./architecture/index
./api/index
./cli/index
./*
File renamed without changes.
78 changes: 12 additions & 66 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,87 +23,33 @@ QGreenland Documentation
acknowledgements.md


.. raw:: latex

\part{Tutorials}


.. toctree::
:name: Tutorials
:caption: Tutorials
:maxdepth: 1
:glob:
:name: User_Documentation
:caption: User Documentation
:hidden:

tutorials/get-started.md
tutorials/video-series-overview.md
tutorials/*


.. raw:: latex

\part{How-to}


.. toctree-select-builder::
:name: How-to
:caption: How-to
:maxdepth: 1
:hidden:

user-how-to/index
:html:contributor-how-to/index


.. raw:: latex

\part{Reference}


.. toctree::
:name: User_Reference
:caption: User Reference
:maxdepth: 1
:hidden:

reference/glossary/index
reference/data-compatibility-guide.md
reference/online-resources.md
user/tutorials/index
user/how-to/index
user/reference/index
user/discussion/index


.. only:: html

.. toctree::
:name: Contributor_Reference
:caption: Contributor Reference
:name: Contributor_Documentation
:caption: Contributor Documentation
:maxdepth: 1
:hidden:

reference/architecture/index
reference/api/index
reference/cli/index
reference/style-guide.md


.. raw:: latex

\part{Discussion topics}
contributor/how-to/index
contributor/reference/index
contributor/discussion/index


.. toctree::
:name: Discussion topics
:caption: Discussion topics
:maxdepth: 1
:glob:
:hidden:

discussion/*


.. only:: html

.. include:: what_is_qgr.md
:parser: myst_parser.sphinx_


.. include:: citing.md
:parser: myst_parser.sphinx_
12 changes: 0 additions & 12 deletions doc/reference/glossary/index.rst

This file was deleted.

79 changes: 0 additions & 79 deletions doc/sphinx-ext/toctree_select_builder.py

This file was deleted.

11 changes: 0 additions & 11 deletions doc/user-how-to/index.rst

This file was deleted.

File renamed without changes.
17 changes: 17 additions & 0 deletions doc/user/discussion/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _user-discussion:


.. raw:: latex

\part{Discussion topics}


==========
Discussion
==========

.. toctree::
:maxdepth: 1
:glob:

./*
File renamed without changes.
17 changes: 17 additions & 0 deletions doc/user/how-to/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _user-how-to:


.. raw:: latex

\part{How-to}


=============
How-to guides
=============

.. toctree::
:maxdepth: 1
:glob:

./*
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ information about NSIDC’s web map services is available here:
[https://nsidc.org/map-services/geospatial-map-services](https://nsidc.org/map-services/geospatial-map-services).

For additional online resources, see the [Online layers
reference](/reference/online-resources.md) page.
reference](/user/reference/online-resources.md) page.
```

![wms_connection_details](/_images/wms_connection_details.png)
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# QGreenland Dataset Compatibility Guide
# Dataset Compatibility Guide

While QGreenland provides a curated base package of data on a variety of topics,
the options for adding additional data are nearly unlimited. We offer different
Expand Down Expand Up @@ -30,20 +30,20 @@ to the public QGreenland data package, please note the following:

## Contributing datasets to QGreenland via GitHub for inclusion in future releases

Follow the instructions found in our {doc}`/discussion/contributing`
guidelines. The QGreenland source code defines “processing pipelines”, which,
when executed on a server or a user’s computer, fetch data from its original
source location, transform it (reproject, reformat, subset, resample, etc.) as
needed, and finally compile these data into a zipped QGreenland QGIS
project. Contributors may customize, re-use, or add to our processing pipelines
to support their new layer, and when their changes are ready, submit a [Pull
Follow the instructions found in our {doc}`/contributor/discussion/contributing`
guidelines. The QGreenland source code defines “processing pipelines”, which, when
executed on a server or a user’s computer, fetch data from its original source location,
transform it (reproject, reformat, subset, resample, etc.) as needed, and finally
compile these data into a zipped QGreenland QGIS project. Contributors may customize,
re-use, or add to our processing pipelines to support their new layer, and when their
changes are ready, submit a [Pull
Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
to contribute valuable changes back to the QGreenland project.

As of QGreenland v2.0.0, we support editing of dataset metadata, QGIS styles,
and data processing steps via simple Python-based configuration that is easy to
learn. See the {doc}`/reference/architecture/configuration` reference page for
more information.
As of QGreenland v2.0.0, we support editing of dataset metadata, QGIS styles, and data
processing steps via simple Python-based configuration that is easy to learn. See the
{doc}`/contributor/reference/architecture/configuration` reference page for more
information.

* Ensure that all outputs of QGreenland processing pipelines are in EPSG:3413
coordinate reference system.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# User Glossary
# Glossary

A "user" is someone who uses QGreenland in QGIS.

Expand Down
17 changes: 17 additions & 0 deletions doc/user/reference/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _user-reference:


.. raw:: latex

\part{Reference}


=========
Reference
=========

.. toctree::
:maxdepth: 1
:glob:

./*
Loading