Skip to content

Commit

Permalink
Fix requirements for docs html build
Browse files Browse the repository at this point in the history
  • Loading branch information
elahrvivaz committed May 3, 2024
1 parent 734c786 commit 8dde283
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 38 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Installing Sphinx and its dependencies in a Python ``virtualenv``:

$ virtualenv .sphinx && source .sphinx/bin/activate
$ pip install -r requirements.txt

Alternatively use ``sudo`` with the ``pip`` command to install the packages in the system Python distribution.

$ sudo pip install -r requirements.txt
Expand Down Expand Up @@ -49,7 +49,7 @@ when it prompts for input. It should build the whole document. If the
table of contents doesn't render properly, delete ``GeoMesa.pdf``
and run ``make`` again.

To build a single HTML file containing all three manuals:
To build a single HTML file containing all two manuals:

$ mvn clean install -Pdocs,singlehtml

Expand Down
27 changes: 0 additions & 27 deletions docs/bin/common.sh

This file was deleted.

7 changes: 0 additions & 7 deletions docs/bin/run-servlet.sh

This file was deleted.

2 changes: 1 addition & 1 deletion docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<configuration>
<target>
<property name="build.directory" value="${project.build.directory}" />
<ant antfile="build.xml" target="${ant.target}" />
<ant antfile="build.xml" dir="${basedir}" target="${ant.target}" />
</target>
</configuration>
<goals>
Expand Down
6 changes: 6 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ sphinx-rtd-theme==1.1.1
docutils<0.18
jinja2==3.1.2
sphinx-copybutton==0.5.1
# pin some older versions that are compatible with sphinx 4.5
sphinxcontrib-applehelp==1.0.3
sphinxcontrib.devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-qthelp==1.0.3
2 changes: 1 addition & 1 deletion docs/user/cli/ingest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The ``--converter`` argument may be any of the following:
* The name of a file containing a converter configuration

If a converter is not specified, GeoMesa will attempt to infer a converter definition based on the input files.
Currently this supports GeoJSON, self-describing Avro, delimited text (TSV, CSV) or Shapefiles. If GeoMesa is able
Currently this supports JSON, XML, self-describing Avro, delimited text (TSV, CSV), and Shapefiles. If GeoMesa is able
to infer a schema and converter definition, the user can accept them as-is, or alternatively use them as the basis
for a fully custom converter. If desired, the user can persist the inferred converter to file, which allows for
easy modification and reuse. When ingesting a large data set, it can be useful to ingest a single file in local
Expand Down

0 comments on commit 8dde283

Please sign in to comment.