Open kloczek opened 1 year ago
With pyproj installed the man pages look correct man ./pyproj.1
:
PYPROJ(1) pyproj PYPROJ(1)
NAME
pyproj - pyproj CLI
pyproj version: 3.4.1.dev0 [PROJ version: 9.1.0]
usage: pyproj [-h] [-v] {sync} ...
OPTIONS
-v, --verbose
Show verbose debugging version information.
Default: False
SUB-COMMANDS:
sync
Tool for synchronizing PROJ datum and transformation support data.
pyproj sync [-h] [--bbox BBOX] [--spatial-test {intersects,contains}]
[--source-id SOURCE_ID] [--area-of-use AREA_OF_USE] [--file FILE]
[--exclude-world-coverage] [--include-already-downloaded]
[--list-files] [--all] [--system-directory]
[--target-directory TARGET_DIRECTORY] [-v]
options
--bbox Specify an area of interest to restrict the resources to down‐
load. The area of interest is specified as a bounding box with
geographic coordinates, expressed in degrees in an unspecified
geographic CRS. west_long and east_long should be in the
[-180,180] range, and south_lat and north_lat in the [-90,90].
west_long is generally lower than east_long, except in the case
where the area of interest crosses the antimeridian.
...
I am not sure there is a good way to get around not installing pyproj.
I've added below patch to generate module documentation as well
Interesting. I only thought that it would be valuable for the CLI.
I am not sure there is a good way to get around not installing pyproj.
As on build stage pyproj
script does not exist yes maybe it is possible to replace somehow call pyproj.__main__.main
? 🤔
As that my patch adds sys.path.insert(0, os.path.abspath(".."))
it should be possible to call thet. I'm not sure how to implement that in .rst files ..
First of all currently it is not possible to use straight
sphinx-build
command to build documentation out of source treeThis can be fixed by patch like below:
This patch fixes what is in the comment and that can of fix is suggested in sphinx example copy.py https://www.sphinx-doc.org/en/master/usage/configuration.html#example-of-configuration-file This patch allows build documentation without have
pyproj
module installed ad it guarantees as well that documentation will be generated out of module from source tree and not from installed module (which may be in different version).Than .. looks like in conf.py is only entry to generate pyproj(1) man page so I've added below patch to generate module documentation as well
Than .. on building my packages I'm using
sphinx-build
command with-n
switch which shows warmings about missing references. These are not critical issues.Here is the output with warnings:
First part of the warnings about missing
pyproj._network
module can be skipped because on that stage I have no installed yetpyproj
module with its DSOs. However other warningsa are affecting mainly html outpu (I'm interested only man page so I'm not affected)You can peak on fixes that kind of issues in other projects https://github.com/latchset/jwcrypto/pull/289 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/latchset/jwcrypto/pull/289 https://github.com/RDFLib/rdflib-sqlalchemy/issues/95 https://github.com/sissaschool/elementpath/commit/bf869d9e https://github.com/jaraco/cssutils/issues/21 https://github.com/pywbem/pywbem/pull/2895 https://github.com/sissaschool/xmlschema/commit/42ea98f2 https://github.com/RDFLib/rdflib/pull/2036 https://github.com/frostming/unearth/issues/14 https://github.com/pypa/distlib/commit/98b9b89f
pyproj(1) man page seems is not finished becaue it contains only