Skip to content

Commit

Permalink
Changes to link the manual from https://docs.geonetwork-opensource.org/
Browse files Browse the repository at this point in the history
  • Loading branch information
josegar74 committed Oct 2, 2023
1 parent ae6e031 commit 7a78b8f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 211 deletions.
44 changes: 3 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,36 +26,7 @@ sudo pip install sphinx-bootstrap-theme
sudo pip install sphinx_rtd_theme
```

The internationalization is build used [sphinx-intl](http://www.sphinx-doc.org/es/stable/intl.html)
You can install it with:

```
sudo pip install sphinx-intl
```

To download the translations from Transifex (optional), you will need the transifex command line client:
https://docs.transifex.com/client/installing-the-client
The Transifex Client is written in Python, so it runs on most systems. The easiest way to install it is with pip:

```
sudo pip install transifex-client
```

### Configuring your local (Optional)

This is only needed if you want to build a multilingual documentation. In that case, you need to configure your
Transifex user:
https://docs.transifex.com/client/client-configuration
~/.transifexrc stores your Transifex.com credentials. This config file is unique per user and it's stored in your home directory.

```
[https://www.transifex.com]
username = your_username/api
token =
password = p@ssw0rd/api_token
hostname = https://www.transifex.com
```
### Building the documentation
### Building the website

First checkout the website source:

Expand All @@ -66,16 +37,7 @@ Then use the shell script:

```bash
cd website
./checkup_docs.sh
```

You can use parameters to make sure you build the website as you expect:
```bash
./checkup_docs.sh --help
Usage: ./checkup_docs only for basic english version
Usage: ./checkup_docs -Platest for English and French using latest translations on Transifex
Usage: ./checkup_docs -Pall for all languages using cached translations
Usage: ./checkup_docs -Platest,all for all languages using latest translations on transifex
mvn install
```

Once the website has been built, you only have to move the contents of the ``build`` folder to the proper URL to publish the website on https://geonetwork-opensource.org.
Once the website has been built, you only have to move the contents of the ``target/website`` folder to the proper URL to publish the website on https://geonetwork-opensource.org.
164 changes: 0 additions & 164 deletions checkup_docs.sh

This file was deleted.

12 changes: 6 additions & 6 deletions docsrc/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ User and developer manuals
Stable version
""""""""""""""

* `English <manuals/4.0.x/en/index.html>`__
* `French <manuals/4.0.x/fr/index.html>`__
* `English <https://docs.geonetwork-opensource.org/4.2>`__
* `French <https://docs.geonetwork-opensource.org/4.2/fr>`__


Version 3.12
""""""""""""

* `English <manuals/3.12.x/en/index.html>`__
* `French <manuals/3.12.x/fr/index.html>`__
* `English <https://docs.geonetwork-opensource.org/3.12>`__
* `French <https://docs.geonetwork-opensource.org/3.12/fr>`__

Version 2.10
""""""""""""

* `User guide <manuals/2.10.4/eng/users/index.html>`_ - The manual is a comprehensive guide to all aspects of using GeoNetwork opensource.
* `User guide <https://docs.geonetwork-opensource.org/2.10/users>`_ - The manual is a comprehensive guide to all aspects of using GeoNetwork opensource.

* `Developer manual <manuals/2.10.4/eng/developer/index.html>`_ - The manual is for those who want to help with the development process, including source code, software releasing, and other administrative work.
* `Developer manual <https://docs.geonetwork-opensource.org/2.10/developer>`_ - The manual is for those who want to help with the development process, including source code, software releasing, and other administrative work.


Articles & links
Expand Down

0 comments on commit 7a78b8f

Please sign in to comment.