Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the script to checkout the manuals from the old repository and update README.md #50

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.