From 2637ed27be3a213d9687109ea9392faa02757b6f Mon Sep 17 00:00:00 2001 From: jfsanchezherrero Date: Mon, 20 Nov 2023 12:53:17 +0100 Subject: [PATCH] add readme --- docs/INFO | 47 +++++++++++++++++++++++++++++++++++------------ docs/README.md | 37 +------------------------------------ 2 files changed, 36 insertions(+), 48 deletions(-) mode change 100644 => 120000 docs/README.md diff --git a/docs/INFO b/docs/INFO index 2786b9a..54f812f 100644 --- a/docs/INFO +++ b/docs/INFO @@ -1,21 +1,44 @@ -https://github.com/richdayandnight/Tutorial_SimpleTeacherAPI +# README Documentation -https://pythonhosted.org/an_example_pypi_project/sphinx.html#is-sweaty -https://medium.com/@richdayandnight/a-simple-tutorial-on-how-to-document-your-python-project-using-sphinx-and-rinohtype-177c22a15b5b +This README contains information regarding the documentation for BacterialTyper -http://www.sphinx-doc.org/en/master/ -http://www.sphinx-doc.org/en/master/usage/quickstart.html +The BacterialTyper documentation is supported and deployed using Sphinx and rinohtype. -https://github.com/matplotlib/sampledoc +Instruction and examples on how to create this documentation were obtained from: +- https://github.com/richdayandnight/Tutorial_SimpleTeacherAPI +- https://pythonhosted.org/an_example_pypi_project/sphinx.html#is-sweaty +- https://medium.com/@richdayandnight/a-simple-tutorial-on-how-to-document-your-python-project-using-sphinx-and-rinohtype-177c22a15b5b +- http://www.sphinx-doc.org/en/master/ +- http://www.sphinx-doc.org/en/master/usage/quickstart.html +- https://github.com/matplotlib/sampledoc +See configuration required in `config/` folder for python, perl and system packages to be installed. -### -pip install sphinx -pip install sphinxmark -pip install rinohtype +- Python +``` +sphinx +sphinxmark +rinohtype +sphinxcontrib-bibtex +``` + +- Perl +``` +latexmk,http://mirrors.ctan.org/support/latexmk.zip +``` + +- System packages +``` +sudo apt install texlive-full +sudo apt install texmaker +sudo apt install graphviz +``` -sphinx-quickstart +To create the documentation execute: + +``` +sphinx-quickstart make html sphinx-build -b rinoh source build/rinoh - +``` diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 723e29d..0000000 --- a/docs/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# README Documentation - -This README contains information regarding the documentation for BacterialTyper - -The BacterialTyper documentation is supported and deployed using Sphinx and rinohtype. - -Instruction and examples on how to create this documentation were obtained from: -- https://github.com/richdayandnight/Tutorial_SimpleTeacherAPI -- https://pythonhosted.org/an_example_pypi_project/sphinx.html#is-sweaty -- https://medium.com/@richdayandnight/a-simple-tutorial-on-how-to-document-your-python-project-using-sphinx-and-rinohtype-177c22a15b5b -- http://www.sphinx-doc.org/en/master/ -- http://www.sphinx-doc.org/en/master/usage/quickstart.html -- https://github.com/matplotlib/sampledoc - -See configuration required in `config/` folder for python, perl and system packages to be installed. - -- Python -``` -sphinx -sphinxmark -rinohtype -sphinxcontrib-bibtex -``` - -- Perl -``` -latexmk,http://mirrors.ctan.org/support/latexmk.zip -``` - -- System packages -``` -sudo apt install texlive-full -sudo apt install texmaker -sudo apt install graphviz -``` - diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file