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

Update alt attributes of images #119

Closed
wants to merge 1 commit into from
Closed
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
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"restructuredtext.confPath": "${workspaceFolder}\\docs"
}
8 changes: 4 additions & 4 deletions docs/DeveloperWorkflow/automated_checks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ base coverage percentage.
**Details** link of the ``Python application / build (push)`` tab.

.. figure:: ../images/all_checks.png
:alt: GitHub pull request Checks
:alt: GitHub pull request Checks - All 4 checks have passed
:align: center
:width: 600px

Expand Down Expand Up @@ -76,7 +76,7 @@ passes. Otherwise if the percentage is lower, the check fails.
the Checks tab.

.. figure:: ../images/all_checks.png
:alt: GitHub pull request Checks
:alt: GitHub pull request Checks - Details link inside Checks tab
:align: center
:width: 600px

Expand All @@ -98,7 +98,7 @@ code that need to be modified.
**Details** link of the ``codeclimate`` tab.

.. figure:: ../images/all_checks.png
:alt: GitHub pull request Checks
:alt: GitHub pull request Checks - Details link inside codeclimate tab
:align: center
:width: 600px

Expand All @@ -111,7 +111,7 @@ code that need to be modified.
the code is ready to be merged!

.. figure:: ../images/code_climate.png
:alt: Codeclimate Dashboard
:alt: Codeclimate Dashboard - No issues are found and the code is ready to be mearged
:align: center
:width: 600px

Expand Down
7 changes: 4 additions & 3 deletions docs/DevelopmentSetup/docker_installation_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,10 @@ The Output files created are visible in the below screenshot:-
Running the moja.cli

.. figure:: ../images/installation_docker/step3a_docker.png
:width: 600
:align: center
:alt: Output files created from runs
:alt: Output files created from runs
:width: 600
:align: center

Output files created from runs

.. _Docker: ../prerequisites/docker.html
34 changes: 17 additions & 17 deletions docs/DevelopmentSetup/visual_studio_win_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ Launch the Windows Powershell and run the following commands:
cd Source\build

.. figure:: ../images/installation_vs2019_flint.example/Step2.png
:alt: Creating a build Directory for Cloned FLINT.example repo
:alt: Creating a build Directory for Cloned FLINT.example repository and moving into it using Command Prompt
:align: center
:width: 600px

Creating a build Directory for Cloned FLINT.example repo
Creating a build Directory for Cloned FLINT.example repository and moving into it using Command Prompt

Now depending on which type of simulation you want to execute, you may
run one of the following generate commands:
Expand All @@ -73,10 +73,10 @@ Commands to run cmake for the spatial simulations:

::

# Spatial simulations
# if your planning to run spatial chapman richards example you also need to enable the gdal module
# Generate the project files
cmake -G "Visual Studio 16 2019" -DCMAKE_INSTALL_PREFIX=C:\Development\Software\moja -DVCPKG_TARGET_TRIPLET=x64-windows -DOPENSSL_ROOT_DIR=c:\Development\moja-global\vcpkg\installed\x64-windows -DENABLE_TESTS=OFF -DENABLE_MOJA.MODULES.GDAL=ON -DCMAKE_TOOLCHAIN_FILE=c:\Development\moja-global\vcpkg\scripts\buildsystems\vcpkg.cmake ..
# Spatial simulations
# if your planning to run spatial chapman richards example you also need to enable the gdal module
# Generate the project files
cmake -G "Visual Studio 16 2019" -DCMAKE_INSTALL_PREFIX=C:\Development\Software\moja -DVCPKG_TARGET_TRIPLET=x64-windows -DOPENSSL_ROOT_DIR=c:\Development\moja-global\vcpkg\installed\x64-windows -DENABLE_TESTS=OFF -DENABLE_MOJA.MODULES.GDAL=ON -DCMAKE_TOOLCHAIN_FILE=c:\Development\moja-global\vcpkg\scripts\buildsystems\vcpkg.cmake ..

.. _Cmake: ../prerequisites/cmake.html
.. _Visual Studio: ../prerequisites/visual_studio.html
Expand All @@ -95,18 +95,18 @@ In order to run and debug the Visual Studio solution -
the ``ALL_BUILD`` node and selecting ``Build``.

.. figure:: ../images/installation_vs2019_flint.example/VS2019_buildall.jpeg
:width: 600
:align: center
:alt: Navigating to Visual Studio Debugging ``ALL_BUILD`` properties page
:alt: Navigating to Visual Studio Debugging ``ALL_BUILD`` properties page
:width: 600
:align: center

Navigating to Visual Studio Debugging ``ALL_BUILD`` properties page
Navigating to Visual Studio Debugging ``ALL_BUILD`` properties page

.. figure:: ../images/installation_vs2019_flint.example/Step4.png
:width: 600
:align: center
:alt: Running ``moja.cli.exe`` in Visual Studio Debugging All properties page
:alt: Running ``moja.cli.exe`` in Visual Studio Debugging All properties page
:width: 600
:align: center

Running ``moja.cli.exe`` in Visual Studio Debugging All properties page
Running ``moja.cli.exe`` in Visual Studio Debugging All properties page

Running in the IDE and debugging is a little tricky. This could more
than likely be resolved with better cmake setups. But for now, there is
Expand Down Expand Up @@ -216,7 +216,7 @@ debug run of the RothC example. You should see something like the
following:

.. figure:: ../images/installation_vs2019_flint.example/VS2019_debugrothc.jpeg
:alt: Debug run for rothc example
:alt: Debug run for ``moja.FLINT.example.rothc``
:align: center
:width: 600px

Expand Down Expand Up @@ -247,7 +247,7 @@ we just built the solution.
``C:\Development\moja-global\FLINT\Source\build\moja.sln`` .

.. figure:: ../images/installation_vs2019_flint.example/gdal/Step3.png
:alt: Navigating to Cmake Configuration Page
:alt: Cmake Configuration Page
:align: center
:width: 600px

Expand All @@ -263,7 +263,7 @@ we just built the solution.
- ENABLE_MOJA.MODULES.ZIPPER

.. figure:: ../images/installation_vs2019_flint.example/gdal/Step4.png
:alt: Checking the flags mentioned
:alt: Tick the boxes of the flags mentioned
:align: center
:width: 600px

Expand Down
14 changes: 7 additions & 7 deletions docs/DevelopmentSetup/windows_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Setting up the FLINT development environment


.. figure:: ../images/windows_installation/develop_branch.png
:alt: Develop branch of FLINT
:alt: ``develop`` branch of FLINT in github
:width: 600
:align: center

Expand Down Expand Up @@ -105,15 +105,15 @@ Run a command shell and navigate to the build folder.
- Right click on **ALL_BUILD** and click on **Build** in the menu.

.. figure:: ../images/windows_installation/all_build_visual_studio.png
:alt: ALL_BUILD of Visual Studio
:alt: Solution Explorer in Visual Studio with ALL_BUILD highlighted
:width: 600
:align: center

Solution Explorer in Visual Studio

- If the output says Build 7 succeeded as shown in the image below, FLINT has built successfully.
.. figure:: ../images/windows_installation/successful_build.png
:alt: Successful Build
:alt: Output of a Successful Build
:width: 600
:align: center

Expand All @@ -131,11 +131,11 @@ Running the project
===================

.. figure:: ../images/installation_vs2019_flint.example/Step4.png
:width: 600
:align: center
:alt: Running ``moja.cli.exe`` in Visual Studio Debugging All properties page
:alt: Running ``moja.cli.exe`` in Debugging tab of ALL_BUILD Property Page
:width: 600
:align: center

Running ``moja.cli.exe`` in Visual Studio Debugging All properties page
Running ``moja.cli.exe`` in Debugging tab of ALL_BUILD Property Page

We are running the ``moja.cli.exe`` from the moja.FLINT project here. In
order to make edits to the Visual Studio Solution we can use the CMake
Expand Down
20 changes: 10 additions & 10 deletions docs/GCBMDevelopmentSetup/prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Existing Python Installation
``install_modules_only <python path>``

.. figure:: ../images/installation_gcbm/image2.png
:alt: Setting up modules for Existing Python Installation
:alt: Running the above command in the Command Prompt of the ``python_3_installer`` directory
:align: center
:width: 600px

Setting up modules for Existing Python Installation
Running the above command in the Command Prompt of the ``python_3_installer`` directory

New Python Installation
~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -46,11 +46,11 @@ New Python Installation
``install_python [optional install path]``

.. figure:: ../images/installation_gcbm/image4.png
:alt: Setting up Python and modules for New Python Installation
:alt: Running the above command in the Command Prompt of the ``python_3_installer`` directory
:align: center
:width: 600px

Setting up Python and modules for New Python Installation
Running the above command in the Command Prompt of the ``python_3_installer`` directory

Microsoft Access Database Driver
--------------------------------
Expand All @@ -65,11 +65,11 @@ a driver to connect to this type of database.
``python_3_installer\installers\AccessDatabaseEngine_x64.exe``

.. figure:: ../images/installation_gcbm/image3.png
:alt: Installing Microsoft Access Database Driver
:alt: ``AccessDatabaseEngine_x64.exe`` in ``python_3_installer`` directory
:align: center
:width: 600px

Installing Microsoft Access Database Driver
``AccessDatabaseEngine_x64.exe`` in ``python_3_installer`` directory

Visual C++ Redistributable Packages
-----------------------------------
Expand All @@ -79,11 +79,11 @@ Install the C++ packages required to run GCBM and supporting tools:
- Double-click ``tools\VC_redist\install_vcredist.bat``

.. figure:: ../images/installation_gcbm/image6.png
:width: 600
:align: center
:alt: Installing the C++ packages required to run GCBM and supporting tools
:alt: ``install_vcredist.bat`` in ``tools\VC_redist`` directory
:width: 600
:align: center

Installing the C++ packages required to run GCBM and supporting tools
``install_vcredist.bat`` in ``tools\VC_redist`` directory

GCBM Video Tutorial
-------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/prerequisites/cmake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,17 @@ On opening the installer:
- Open the installer, click **Next**.
- Accept the terms and click **Next**.
.. figure:: ../images/cmake/cmake_license.PNG
:alt: License page of CMake
:alt: License page of CMake - Check box to accept the End-User License Agreement
:align: center

License Page of CMake

- Select the **Add CMake to the system PATH for all users** option in the Install options section.
.. figure:: ../images/cmake/cmake_install.PNG
:alt: Install page of CMake
:alt: Install page of CMake - check ``Add CMake to the system PATH for all users`` box
:align: center

Install Page of CMake

- Click **Next** and finally click **Install**
- After CMake is installed, restart your system.