Skip to content
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
2 changes: 1 addition & 1 deletion doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SUBDIRS = \
include $(MODULE_TOPDIR)/include/Make/Dir.make

FILES := $(wildcard *.html)
# So far, we disntinguished user and contributor documentation here by
# So far, we distinguished user and contributor documentation here by
# extension. This is no longer possible with Markdown.
MDFILES := grass_database.md \
projectionintro.md \
Expand Down
25 changes: 23 additions & 2 deletions python/grass/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
)

grass_version = core.version()["version"]
today = date.today()
today = date.today().strftime("%B %d, %Y")

copy("_templates/layout.html.template", "_templates/layout.html")

Expand All @@ -114,6 +114,28 @@
"sphinx_sitemap",
]


# Skip temporal lexer rule methods because their regex docstrings are not intended
# for reStructuredText parsing and only serve PLY token definitions. The modules
# are checked under both names because the sys.path entries above make them
# importable both as grass.temporal.* and as temporal.*.
def skip_member(app, what, name, obj, skip, options):
if name.startswith("t_"):
mod = getattr(obj, "__module__", None)
if mod in {
"grass.temporal.temporal_algebra",
"grass.temporal.temporal_operator",
"temporal.temporal_algebra",
"temporal.temporal_operator",
}:
return True
return None


def setup(app):
app.connect("autodoc-skip-member", skip_member)


# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down Expand Up @@ -192,7 +214,6 @@
"repo_url": "https://github.com/OSGeo/grass/",
"repo_name": "GRASS",
"repo_type": "github",
"logo": "grass_logo.svg",
Comment thread
echoix marked this conversation as resolved.
Resolved
# Visible levels of the global TOC; -1 means unlimited
"globaltoc_depth": 1,
# If False, expand all TOC entries
Expand Down
4 changes: 2 additions & 2 deletions python/grass/docs/src/gunittest_running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ Running tests and creating report

Currently there is full support only for running all the tests in
the small (basic) version of GRASS sample Location for North Carolina
(see `GRASS sample data`).
(see `GRASS sample data`_).

.. _GRASS sample data: https://grass.osgeo.org/download/sample-data
.. _GRASS sample data: https://grass.osgeo.org/download/data/


Example Bash script to run be used as a cron job
Expand Down
7 changes: 3 additions & 4 deletions python/grass/docs/src/gunittest_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ caused by C library functions does not influence the main testing process.

Some tests will run without any data but many tests require
the small (basic) version of GRASS sample Location for North Carolina
(see `GRASS sample data`).
(see `GRASS sample data`_).

Basic example
-------------
Expand Down Expand Up @@ -715,10 +715,9 @@ Further reading
gunittest_running_tests


.. _unittest: https://docs.python.org/2/library/unittest.html
.. _doctest: https://docs.python.org/2/library/doctest.html
.. _unittest: https://docs.python.org/3/library/unittest.html
.. _Coverity Scan: https://scan.coverity.com/
.. _1038: https://scan.coverity.com/projects/1038
.. _Cppcheck: http://cppcheck.sourceforge.net/
.. _sandbox: https://svn.osgeo.org/grass/sandbox/wenzeslaus/grass_py_static_check.py
.. _GRASS sample data: https://grass.osgeo.org/download/data/ and http://fatra.cnr.ncsu.edu/data/ (nc_spm_full_v2beta1)
.. _GRASS sample data: https://grass.osgeo.org/sampledata/north_carolina/
3 changes: 2 additions & 1 deletion python/grass/docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,13 @@ Modules and Packages
.. toctree::
:maxdepth: 1

index
grass
grass.tools
script_intro
pygrass_index
grass.jupyter
exceptions
imaging
pydispatch
temporal_framework
gunittest_testing
Loading