Sphinx Extensions to support API reference sites in OpenStack.
The package is a collection of sphinx stanzas that assist in building an API
Reference site for an OpenStack project in RST. RST is great for unstructured
English, but displaying semi structured (and repetitive) data in tables is not
its strength. This provides tooling to insert semi-structured data describing
request and response parameters and status or error messages, and turn those
into nice tables.
The package also includes a set of styling (and javascript) that is expected to
layer on top of a Sphinx theme base. This addition provides a nice set of
collapsing sections for REST methods and javascript controls to expand or
collapse all sections.
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above. NOTE: This is a Python port. Instead of py311-os-api-ref listed in the above command, you can pick from the names under the Packages section.
textproc/py-os-api-ref: Update to 3.1.0
* Adjust USES=python accordingly, because Python 3.8 is no longer
present in the ports tree after ca15850a2b13 while I'm here.
* Switch to the PEP517 build framework as well.
Changelog:
https://github.com/openstack/os-api-ref/compare/3.0.1...3.1.0
python: bump all USE_PYTHON=distutils consumers after RUN_DEPENDS removal
Any missed ports, feel free to bump.
Any ports that need setuptools at runtime can have the devel/py-setuptools
manually added back to RUN_DEPENDS, but understand that this practice
is deprecated; see CHANGES for details.
all: remove explicit versions in USES=python for "3.x+"
The logic in USES=python will automatically convert this to 3.8+ by
itself.
Adjust two ports that only had Python 3.7 mentioned but build fine
on Python 3.8 too.
finance/quickfix: mark BROKEN with PYTHON
libtool: compile: c++ -DHAVE_CONFIG_H -I. -I../.. -I -I. -I.. -I../.. -I../C++
-DLIBICONV_PLUG -DPYTHON_MAJOR_VERSION=3 -Wno-unused-variable
-Wno-maybe-uninitialized -O2 -pipe -DLIBICONV_PLUG -fstack-protector-strong
-fno-strict-aliasing -DLIBICONV_PLUG -Wall -ansi
-Wno-unused-command-line-argument -Wpointer-arith -Wwrite-strings
-Wno-overloaded-virtual -Wno-deprecated-declarations -Wno-deprecated -std=c++0x
-MT _quickfix_la-QuickfixPython.lo -MD -MP -MF
.deps/_quickfix_la-QuickfixPython.Tpo -c QuickfixPython.cpp -fPIC -DPIC -o
.libs/_quickfix_la-QuickfixPython.o
warning: unknown warning option '-Wno-maybe-uninitialized'; did you mean
'-Wno-uninitialized'? [-Wunknown-warning-option]
QuickfixPython.cpp:175:11: fatal error: 'Python.h' file not found
^~~~~~~~~~
1 warning and 1 error generated.
Reviewed by: portmgr, vishwin, yuri
Differential Revision: <https://reviews.freebsd.org/D40568>
Remove WWW entries moved into port Makefiles
Commit b7f05445c00f has added WWW entries to port Makefiles based on
WWW: lines in pkg-descr files.
This commit removes the WWW: lines of moved-over URLs from these
pkg-descr files.
Approved by: portmgr (tcberner)
Add WWW entries to port Makefiles
It has been common practice to have one or more URLs at the end of the
ports' pkg-descr files, one per line and prefixed with "WWW:". These
URLs should point at a project website or other relevant resources.
Access to these URLs required processing of the pkg-descr files, and
they have often become stale over time. If more than one such URL was
present in a pkg-descr file, only the first one was tarnsfered into
the port INDEX, but for many ports only the last line did contain the
port specific URL to further information.
There have been several proposals to make a project URL available as
a macro in the ports' Makefiles, over time.
(Only the first 15 lines of the commit message are shown above )
textproc/py-openstackdocstheme: Update to 2.2.7
* Remove the DOCS option as the documentation contains mostly references to
external sites and isn't really useful for offline use.
* Also update the RUN_DEPENDS of consumer textproc/py-os-api-ref to avoid
conflicting dependencies and bump its PORTREVISION accordingly.
Changelog:
https://github.com/openstack/openstackdocstheme/compare/1.21.0...2.2.7
Update Sphinx
- Repocopy textproc/py-sphinx to textproc/py-sphinx18
Update it to 1.8.5 (latest version from 1.8.X).
This version supports Python 2 and 3.
Add test target.
- textproc/py-sphinx: Update to 3.0.2
Python 3 only (3.5+).
Add test target.
- Mk/Uses/python.mk: Add PY_SPHINX
(Only the first 15 lines of the commit message are shown above )
Change my maintainer email address to my new one at the FreeBSD project.
Reviewed by: miwi (mentor)
Approved by: miwi (mentor)
Differential Revision: https://reviews.freebsd.org/D19050
Sphinx Extensions to support API reference sites in OpenStack.
The package is a collection of sphinx stanzas that assist in building an API
Reference site for an OpenStack project in RST. RST is great for unstructured
English, but displaying semi structured (and repetitive) data in tables is not
its strength. This provides tooling to insert semi-structured data describing
request and response parameters and status or error messages, and turn those
into nice tables.
The package also includes a set of styling (and javascript) that is expected to
layer on top of a Sphinx theme base. This addition provides a nice set of
collapsing sections for REST methods and javascript controls to expand or
collapse all sections.
WWW: https://docs.openstack.org/os-api-ref/
PR: 228846
Submitted by: freebsd_ports@k-worx.org
Sponsored by: iXsystems Inc.
