From e2f1765d9ee208cbfaa32852400468ecdbde2bab Mon Sep 17 00:00:00 2001 From: Tomas Lovato <tomas.lovato@cmcc.it> Date: Thu, 23 Feb 2023 11:38:19 +0100 Subject: [PATCH] remove duplicated file on sphinx usage, now in README.rst --- source/sphinx.rst | 56 ----------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 source/sphinx.rst diff --git a/source/sphinx.rst b/source/sphinx.rst deleted file mode 100644 index e6a213f..0000000 --- a/source/sphinx.rst +++ /dev/null @@ -1,56 +0,0 @@ -********************** -NEMO Quick Start Guide -********************** - -| The NEMO guide is made up of several files written in - `ReStructuredText <http://docutils.sourceforge.net/rst.html>`_ (`.rst` extension), - a WYSIWYG markup language used in the Python community, and scattered all over the NEMO sources. -| You can view them one by one in plain text from `./source` folder, or export all to a user-friendly guide under `./build` (only HTML format at the moment, PDF expected later). - -Build and export the guide in HTML -================================== - -1. Install Sphinx documentation generator, its BibTeX extension and "Read The Docs" theme thanks to `pip` packages tool - - .. code-block:: console - - $ pip install sphinx sphinxcontrib.bibtex sphinx_rtd_theme - -2. Build the HTML export with `make` in `./build/html` - - .. code-block:: console - - $ make html - -3. Finally browse the guide by opening `./build/html/NEMO_guide.html` - - -Edit the sources and check the output in real time -================================================== - -| To facilitate the update of the guide, editors can install a useful package that will automatically trigger a new build and the reload of the HTML page for every recorded change in the sources. -| So the reviewer saves time by controlling on-line their modifications almost as it types and also by avoiding repeated interactive rebuilds. - -Install `sphinx-autobuild` package - -.. code-block:: console - - $ pip install sphinx-autobuild - -Launch a local web server hosting a draft export of the guide (build this time in `./build/livehtml`) - -.. code-block:: console - - $ make livehtml - -| Open in the same time the 2 formats of the content to review: the source file and the web page by browsing from the new guide hosted by your local server on `<http://127.0.0.1:8000/NEMO_guide.html>`_. -| Start the update, save your changes and verify instantly the HTML export in your browser. - -.. warning:: - - | Your modifications are not taken into account? - | For symlink file, you will have to close it to update the HTML export. Otherwise look at the log of the Sphinx build, you probably made a typo! - -.. hint:: - - Are there broken links? Fix "Page not found" errors by running `make linkcheck` -- GitLab