Skip to content

Commit 659b34c

Browse files
jodygarnettjodygarnett
committed
Bundle docs and update release notes
1 parent b0c6578 commit 659b34c

File tree

6 files changed

+103
-10
lines changed

6 files changed

+103
-10
lines changed

‎README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,18 +108,19 @@ See https://wiki.osgeo.org/wiki/SAC:Repo to obtain credentials:
108108
## Docs
109109

110110
Uses Python3 environment for ***sphinx-build* documentation:
111-
```
112-
pip3 install -r requirements.txt
113-
```
114111

115-
Build with Makefile:
116112
```
117-
make html
113+
pip3 install -r docs/requirements.txt
114+
sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
115+
open _build/html/index.html
118116
```
119117

120-
Or command line:
118+
Docs are created in ``docs/_build/html`` folder.
119+
120+
Maven `docs` profile will assemble the docs into a zip bundle if ``docs/_build/html/index.html`` exists.
121+
121122
```
122-
sphinx-build
123+
mvn package
123124
```
124125

125126
## Release

‎ReleaseNotes.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
# Mapfish Print 2 Release notes
22

3-
## Release 2.2.0
3+
## Release 2.3.0
4+
5+
Release notes:
6+
7+
* Update to GeoTools 30.0 which requires Java 11
8+
* Changed to maven build for Java 11 compatibility
9+
* Massive influx of new functionality from GeoSolutions
10+
* Max number of columns configuration for multi column legends
11+
* Simple colored box icon in legends
12+
* Explicit support of Geoserver CQL_FILTER parameter (also with layers merge support)
13+
* Legend fitting
14+
* Don't break legend items
15+
* Reorder legends block in columns
16+
* Images content
17+
* Dynamic images page
18+
* Multipage legends
19+
* Custom intervals in ScalebarBlock
20+
* Clustering Support
21+
* HTML rendering in text blocks
22+
* Extra Pages
23+
* Group Rendering in attribute blocks
24+
* Skip rendering of pages
25+
* Automatic X-Forwarded-For
26+
* Parsing of Base64 encoded images
27+
* Release is focused on ``print-lib`` required for MapStore, GeoNode and GeoServer projects
28+
* Deploy to OSGeo repository
29+
* Updated docs to reflect new functionality
30+
* Added user-doc bundle and publication to *
431

5-
* TBD
632

733
## Release 2.2.0
834

‎docs/configuration.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -932,7 +932,7 @@ Every matching overrides is applied in order and will override the values define
932932

933933
For example, if you want to draw an attribute block like that:
934934

935-
.. image:: _static/tableConfig.png
935+
.. image:: images/tableConfig.png
936936

937937
You define that:
938938

docs/_static/tableConfig.png renamed to docs/images/tableConfig.png

File renamed without changes.

‎pom.xml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -432,4 +432,39 @@
432432
</snapshotRepository>
433433
</distributionManagement>
434434

435+
<profiles>
436+
<!-- build docs first, and this profile -->
437+
<!-- will assemble into a zip download -->
438+
<profile>
439+
<id>doc</id>
440+
<activation>
441+
<file>
442+
<exists>docs/_build/html/index.html</exists>
443+
</file>
444+
</activation>
445+
<build>
446+
<plugins>
447+
<plugin>
448+
<artifactId>maven-assembly-plugin</artifactId>
449+
<version>3.6.0</version>
450+
<configuration>
451+
<descriptors>
452+
<descriptor>src/assembly/docs.xml</descriptor>
453+
</descriptors>
454+
</configuration>
455+
<executions>
456+
<execution>
457+
<id>make-assembly</id>
458+
<phase>package</phase>
459+
<goals>
460+
<goal>single</goal>
461+
</goals>
462+
</execution>
463+
</executions>
464+
</plugin>
465+
</plugins>
466+
</build>
467+
</profile>
468+
</profiles>
469+
435470
</project>

‎src/assembly/docs.xml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- ======================================================================
3+
Assembly descriptor for binaries. This descriptor is a modified
4+
copy of the Maven "bin" predefined descriptor published there:
5+
6+
http://maven.apache.org/plugins/maven-assembly-plugin/descriptor-refs.html#bin
7+
8+
It will creates a "mapfish-print-${project.version}-docs.zip" file.
9+
10+
$Id$
11+
$URL$
12+
====================================================================== -->
13+
<assembly>
14+
<id>docs</id>
15+
<formats>
16+
<format>zip</format>
17+
</formats>
18+
<fileSets>
19+
<fileSet>
20+
<useDefaultExcludes>true</useDefaultExcludes>
21+
<directory>docs/_build/html</directory>
22+
<outputDirectory></outputDirectory>
23+
</fileSet>
24+
</fileSets>
25+
<files>
26+
<file>
27+
<source>LICENSE.md</source>
28+
<destName>LICENSE.txt</destName>
29+
</file>
30+
</files>
31+
</assembly>

0 commit comments

Comments
 (0)