Skip to content

Commit

Permalink
more adquate docs instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
joaomcteixeira committed May 25, 2022
1 parent 2602741 commit 8dfe71c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 9 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,23 @@ stable beta version.

## 1. Installation

To install HADDOCK3 follow the instructions in the [INSTALL](docs/INSTALL.md) file.
To install HADDOCK3 follow the instructions in the [INSTALL](docs/INSTALL.md)
file.

## 2. Documentation

HADDOCK3-beta documentation is not yet hosted online. You need to generate
it locally. First, install HADDOCK3 and activate the `haddock3` python
environment. Then, in your terminal window, run:
HADDOCK3-beta documentation is not yet hosted online. You need to generate it
locally. First, install HADDOCK3 and activate the `haddock3` python environment
as explained in the [installation instructions](docs/INSTALL.md). Then, in your
terminal window, run:

```bash
tox -e docs
```

After, use your favorite browser to open the file
`dist/docs/index.html`. Navigate around, enjoy, and contribute.
*Ignore any warning messages.* After, use your favorite browser to open the file
`haddock3-docs/index.html`. This will open a local webpage with the complete
HADDOCK3 documentation. Navigate around, enjoy, and contribute.

## 2. Examples

Expand All @@ -43,6 +46,12 @@ If you want to contribute to HADDOCK3's development, read the

## 4. Keep in contact and support us

HADDOCK3 is an academic project supported by various grants, including the EU BioExcel Center of Excellence for Computational Biomolecular Research. HADDOCK3 is fully open-source and free to download. If you clone this repository and use HADDOCK3 for your research, please support us by signing [this Goole form][googleform] if you have not yet done so. This will allow us contact you when needed for HADDOCK3-related issues, and also provide us a mean to demonstrate impact when reporting for grants.
HADDOCK3 is an academic project supported by various grants, including the EU
BioExcel Center of Excellence for Computational Biomolecular Research. HADDOCK3
is fully open-source and free to download. If you clone this repository and use
HADDOCK3 for your research, please support us by signing [this Goole
form][googleform] if you have not yet done so. This will allow us contact you
when needed for HADDOCK3-related issues, and also provide us a mean to
demonstrate impact when reporting for grants.

[googleform]: https://docs.google.com/forms/d/e/1FAIpQLScDcd0rWtuzJ_4nftkDAHoLVwr1IAVwNJGhbaZdTYZ4vWu25w/viewform
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ usedevelop = true
deps =
-r{toxinidir}/devtools/docs-requirements.txt
commands =
sphinx-build {posargs:-E} -b html docs dist/docs
#sphinx-build -b linkcheck docs dist/docs
sphinx-build {posargs:-E} -b html docs haddock3-docs
#sphinx-build -b linkcheck docs haddock3-docs

# code quality assessment. This is not a check in the CI, serves just
# as info for the developer
Expand Down

0 comments on commit 8dfe71c

Please sign in to comment.