From 8dfe71c078da3fece835cd66a5caa3232ee8895d Mon Sep 17 00:00:00 2001 From: joaomcteixeira Date: Wed, 25 May 2022 12:04:51 +0200 Subject: [PATCH] more adquate docs instructions --- README.md | 23 ++++++++++++++++------- tox.ini | 4 ++-- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c3701c11e..53901d381 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/tox.ini b/tox.ini index e64885702..31af48e9d 100644 --- a/tox.ini +++ b/tox.ini @@ -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