Skip to content

Commit

Permalink
Deploying to gh-pages from @ 80869ad 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@gnikit
gnikit committed Jan 8, 2024
1 parent 534612f commit c263334
Show file tree
Hide file tree
Showing 274 changed files with 5,469 additions and 3,535 deletions.
29 changes: 15 additions & 14 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
<link href="./css/local.css" rel="stylesheet">
<link href="./tipuesearch/tipuesearch.css" rel="stylesheet">

<script src="https://code.jquery.com/jquery-3.7.0.slim.min.js" integrity="sha256-tG5mcZUtJsZvyKAxYLVXrmjKBVLd6VpVccqz/r4ypFE=" crossorigin="anonymous"></script>
<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
<script src="./js/svg-pan-zoom.min.js"></script>
</head>

<body>
Expand Down Expand Up @@ -48,7 +49,7 @@
<a class="nav-link" href="./lists/types.html">Derived Types</a>
</li>
<li class="nav-item">
<a class="nav-link" href="./program/main.html">Program</a>
<a class="nav-link" href="program/main.html">Program</a>
</li>
</ul>
<div class="d-flex align-items-end flex-grow-1">
Expand Down Expand Up @@ -102,24 +103,24 @@ <h2 id="the-package-manifest">The package manifest</h2>
<p>For a more practical but less complete guide on creating <em>fpm</em> projects see the <a href="page/Packaging.html">packaging guide</a>.</p>
</div>
<p>The details of the TOML parsing are implemented with using the <a href="https://toml-f.github.io/toml-f">tomlf</a> module.
Generally, the interface to all TOML related functions for <em>fpm</em> is found in the proxy module <a href="/module/fpm_toml.html">fpm_toml</a>.</p>
<p>All the manifest types are bundled in <a href="/module/fpm_manifest.html">fpm_manifest</a>.
While the specific subtables for the package configuration are found in the <code>src/fpm/manifest</code> directory, they should be reexported in the <a href="/module/fpm_manifest.html">fpm_manifest</a> module if they should be elsewhere in <em>fpm</em>.</p>
Generally, the interface to all TOML related functions for <em>fpm</em> is found in the proxy module <a href="module/fpm_toml.html">fpm_toml</a>.</p>
<p>All the manifest types are bundled in <a href="module/fpm_manifest.html">fpm_manifest</a>.
While the specific subtables for the package configuration are found in the <code>src/fpm/manifest</code> directory, they should be reexported in the <a href="module/fpm_manifest.html">fpm_manifest</a> module if they should be elsewhere in <em>fpm</em>.</p>
<h2 id="command-line-interface">Command line interface</h2>
<p><em>fpm</em> is mainly used as a command line tool.
To work with an <em>fpm</em> project as a user you can completely rely on the command line.</p>
<p>The command line interface is build with the <a href="https://github.com/urbanjost/M_CLI2">M_CLI2</a> module and can be found in <a href="/module/fpm_command_line.html">fpm_command_line</a>.</p>
<p>The command line interface is build with the <a href="https://github.com/urbanjost/M_CLI2">M_CLI2</a> module and can be found in <a href="module/fpm_command_line.html">fpm_command_line</a>.</p>
<h2 id="the-package-model">The package model</h2>
<p>Once front-end inputs have been received from the package manifest and command line interface, <em>fpm</em> will construct an
internal representation of the package and its dependencies. This internal representation is known as the package <em>model</em>.
The model and its associated data types should encapsulate all the information required to correctly build a package and
should be independent of the intended backend build system. Information stored in the model includes: build targets and
their inter-dependencies; compiler and compiler flags; library linking information.</p>
<p>For more information on the contents of the package model and the process for constructing it, please see <a href="/module/fpm_model.html">fpm_model</a>.</p>
<p>For more information on the contents of the package model and the process for constructing it, please see <a href="module/fpm_model.html">fpm_model</a>.</p>
<h2 id="the-build-backend">The build backend</h2>
<p>Once a complete package model has been constructed, it can be passed to a <em>backend</em> for either performing the compilation
and linking of targets, or for generating configuration files for a third-party build system.
Currently, only a native backend is implemented in <em>fpm</em>. See <a href="/module/fpm_backend.html">fpm_backend</a> for more information.</p>
Currently, only a native backend is implemented in <em>fpm</em>. See <a href="module/fpm_backend.html">fpm_backend</a> for more information.</p>
<h2 id="generating-this-documentation">Generating this documentation</h2>
<p>This documentation is generated by <a href="https://github.com/Fortran-FOSS-Programmers/FORD">FORD</a>.
For more details on the <a href="https://github.com/fortran-lang/fpm/docs.md">project file</a> and the comment markup in the source code visit the <a href="https://github.com/Fortran-FOSS-Programmers/ford/wiki">FORD documentation</a>.</p>
Expand All @@ -146,7 +147,7 @@ <h4 class="card-text">fortran-lang/fpm contributors</h4>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Source Files</h3>
<ul><li><a href='./sourcefile/build.f90.html'>build.f90</a></li><li><a href='./sourcefile/dependency.f90.html'>dependency.f90</a></li><li><a href='./sourcefile/dependency.f90~2.html'>dependency.f90</a></li><li><a href='./sourcefile/downloader.f90.html'>downloader.f90</a></li><li><a href='./sourcefile/error.f90.html'>error.f90</a></li><li><a href='./sourcefile/example.f90.html'>example.f90</a></li><li><a href='./sourcefile/executable.f90.html'>executable.f90</a></li><li><a href='./sourcefile/fortran.f90.html'>fortran.f90</a></li><li><a href='./sourcefile/fpm.f90.html'>fpm.f90</a></li><li><a href='./sourcefile/fpm_backend.f90.html'>fpm_backend.F90</a></li></ul>
<ul><li><a href='sourcefile/build.f90.html'>build.f90</a></li><li><a href='sourcefile/dependency.f90.html'>dependency.f90</a></li><li><a href='sourcefile/dependency.f90~2.html'>dependency.f90</a></li><li><a href='sourcefile/downloader.f90.html'>downloader.f90</a></li><li><a href='sourcefile/error.f90.html'>error.f90</a></li><li><a href='sourcefile/example.f90.html'>example.f90</a></li><li><a href='sourcefile/executable.f90.html'>executable.f90</a></li><li><a href='sourcefile/fortran.f90.html'>fortran.f90</a></li><li><a href='sourcefile/fpm.f90.html'>fpm.f90</a></li><li><a href='sourcefile/fpm_backend.f90.html'>fpm_backend.F90</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -157,7 +158,7 @@ <h3>Source Files</h3>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Modules</h3>
<ul><li><a href='./module/fpm.html'>fpm</a></li><li><a href='./module/fpm_backend.html'>fpm_backend</a></li><li><a href='./module/fpm_backend_console.html'>fpm_backend_console</a></li><li><a href='./module/fpm_backend_output.html'>fpm_backend_output</a></li><li><a href='./module/fpm_cmd_install.html'>fpm_cmd_install</a></li><li><a href='./module/fpm_cmd_new.html'>fpm_cmd_new</a></li><li><a href='./module/fpm_cmd_publish.html'>fpm_cmd_publish</a></li><li><a href='./module/fpm_cmd_update.html'>fpm_cmd_update</a></li><li><a href='./module/fpm_command_line.html'>fpm_command_line</a></li><li><a href='./module/fpm_dependency.html'>fpm_dependency</a></li></ul>
<ul><li><a href='module/fpm.html'>fpm</a></li><li><a href='module/fpm_backend.html'>fpm_backend</a></li><li><a href='module/fpm_backend_console.html'>fpm_backend_console</a></li><li><a href='module/fpm_backend_output.html'>fpm_backend_output</a></li><li><a href='module/fpm_cmd_install.html'>fpm_cmd_install</a></li><li><a href='module/fpm_cmd_new.html'>fpm_cmd_new</a></li><li><a href='module/fpm_cmd_publish.html'>fpm_cmd_publish</a></li><li><a href='module/fpm_cmd_update.html'>fpm_cmd_update</a></li><li><a href='module/fpm_command_line.html'>fpm_command_line</a></li><li><a href='module/fpm_dependency.html'>fpm_dependency</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -168,7 +169,7 @@ <h3>Modules</h3>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Procedures</h3>
<ul><li><a href='./proc/add_dependency.html'>add_dependency</a></li><li><a href='./proc/add_executable_sources.html'>add_executable_sources</a></li><li><a href='./proc/add_sources_from_dir.html'>add_sources_from_dir</a></li><li><a href='./proc/add_target.html'>add_target</a></li><li><a href='./proc/bad_name_error.html'>bad_name_error</a></li><li><a href='./proc/build_model.html'>build_model</a></li><li><a href='./proc/build_package.html'>build_package</a></li><li><a href='./interface/build_progress_t.html'>build_progress_t</a></li><li><a href='./proc/change_directory.html'>change_directory</a></li><li><a href='./proc/check_and_read_pkg_data.html'>check_and_read_pkg_data</a></li></ul>
<ul><li><a href='proc/add_dependency.html'>add_dependency</a></li><li><a href='proc/add_executable_sources.html'>add_executable_sources</a></li><li><a href='proc/add_sources_from_dir.html'>add_sources_from_dir</a></li><li><a href='proc/add_target.html'>add_target</a></li><li><a href='proc/bad_name_error.html'>bad_name_error</a></li><li><a href='proc/build_model.html'>build_model</a></li><li><a href='proc/build_package.html'>build_package</a></li><li><a href='interface/build_progress_t.html'>build_progress_t</a></li><li><a href='proc/change_directory.html'>change_directory</a></li><li><a href='proc/check_and_read_pkg_data.html'>check_and_read_pkg_data</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -179,7 +180,7 @@ <h3>Procedures</h3>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Derived Types</h3>
<ul><li><a href='./type/build_config_t.html'>build_config_t</a></li><li><a href='./type/build_progress_t.html'>build_progress_t</a></li><li><a href='./type/build_target_ptr.html'>build_target_ptr</a></li><li><a href='./type/build_target_t.html'>build_target_t</a></li><li><a href='./type/console_t.html'>console_t</a></li><li><a href='./type/dependency_config_t.html'>dependency_config_t</a></li><li><a href='./type/dependency_node_t.html'>dependency_node_t</a></li><li><a href='./type/dependency_tree_t.html'>dependency_tree_t</a></li><li><a href='./type/downloader_t.html'>downloader_t</a></li><li><a href='./type/enum_descriptor.html'>enum_descriptor</a></li></ul>
<ul><li><a href='type/build_config_t.html'>build_config_t</a></li><li><a href='type/build_progress_t.html'>build_progress_t</a></li><li><a href='type/build_target_ptr.html'>build_target_ptr</a></li><li><a href='type/build_target_t.html'>build_target_t</a></li><li><a href='type/console_t.html'>console_t</a></li><li><a href='type/dependency_config_t.html'>dependency_config_t</a></li><li><a href='type/dependency_node_t.html'>dependency_node_t</a></li><li><a href='type/dependency_tree_t.html'>dependency_tree_t</a></li><li><a href='type/downloader_t.html'>downloader_t</a></li><li><a href='type/enum_descriptor.html'>enum_descriptor</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -193,14 +194,14 @@ <h3>Derived Types</h3>
<footer>
<div class="container">
<div class="row justify-content-between">
<div class="col"><p>Fortran-lang/fpm was developed by fortran-lang/fpm contributors<br>&copy; 2023
<div class="col"><p>Fortran-lang/fpm was developed by fortran-lang/fpm contributors<br>&copy; 2024
</p>
</div>
<div class="col">
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-12-28 16:08 </p>
on 2024-01-08 09:21 </p>
</div>
</div>
<br>
Expand Down
13 changes: 8 additions & 5 deletions interface/build_progress_t.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- -*- mode: jinja2 -*- -->

<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -17,7 +19,8 @@
<link href="../css/local.css" rel="stylesheet">
<link href="../tipuesearch/tipuesearch.css" rel="stylesheet">

<script src="https://code.jquery.com/jquery-3.7.0.slim.min.js" integrity="sha256-tG5mcZUtJsZvyKAxYLVXrmjKBVLd6VpVccqz/r4ypFE=" crossorigin="anonymous"></script>
<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
<script src="../js/svg-pan-zoom.min.js"></script>
</head>

<body>
Expand Down Expand Up @@ -48,7 +51,7 @@
<a class="nav-link" href="../lists/types.html">Derived Types</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../program/main.html">Program</a>
<a class="nav-link" href="program/main.html">Program</a>
</li>
</ul>
<div class="d-flex align-items-end flex-grow-1">
Expand Down Expand Up @@ -152,7 +155,7 @@ <h2>public interface build_progress_t</h2>

<h2>Module Procedures</h2>
<div class="card">
<div class="card-header codesum"><span class="anchor" id="proc-new_build_progress"></span><h3>private function new_build_progress(target_queue, plain_mode) result(progress)
<div class="card-header codesum"><span class="anchor" id="proc-new_build_progress"></span> <h3>private function new_build_progress(target_queue, plain_mode) result(progress)
</h3></div>
<div class="card-body">
<p>Initialise a new build progress object</p>
Expand Down Expand Up @@ -217,14 +220,14 @@ <h4>
<footer>
<div class="container">
<div class="row justify-content-between">
<div class="col"><p>Fortran-lang/fpm was developed by fortran-lang/fpm contributors<br>&copy; 2023
<div class="col"><p>Fortran-lang/fpm was developed by fortran-lang/fpm contributors<br>&copy; 2024
</p>
</div>
<div class="col">
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-12-28 16:08 </p>
on 2024-01-08 09:21 </p>
</div>
</div>
<br>
Expand Down
19 changes: 11 additions & 8 deletions interface/fnv_1a.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- -*- mode: jinja2 -*- -->

<!DOCTYPE html>
<html lang="en">
<head>
Expand All @@ -17,7 +19,8 @@
<link href="../css/local.css" rel="stylesheet">
<link href="../tipuesearch/tipuesearch.css" rel="stylesheet">

<script src="https://code.jquery.com/jquery-3.7.0.slim.min.js" integrity="sha256-tG5mcZUtJsZvyKAxYLVXrmjKBVLd6VpVccqz/r4ypFE=" crossorigin="anonymous"></script>
<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
<script src="../js/svg-pan-zoom.min.js"></script>
</head>

<body>
Expand Down Expand Up @@ -48,7 +51,7 @@
<a class="nav-link" href="../lists/types.html">Derived Types</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../program/main.html">Program</a>
<a class="nav-link" href="program/main.html">Program</a>
</li>
</ul>
<div class="d-flex align-items-end flex-grow-1">
Expand Down Expand Up @@ -153,7 +156,7 @@ <h2>public interface fnv_1a</h2>

<h2>Module Procedures</h2>
<div class="card">
<div class="card-header codesum"><span class="anchor" id="proc-fnv_1a_char"></span><h3>private pure function fnv_1a_char(input, seed) result(hash)
<div class="card-header codesum"><span class="anchor" id="proc-fnv_1a_char"></span> <h3>private pure function fnv_1a_char(input, seed) result(hash)
</h3></div>
<div class="card-body">
<p>Hash a character(*) string of default kind</p>
Expand All @@ -171,7 +174,7 @@ <h4>Arguments</h4>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-input"></span>
<span class="anchor" id="variable-input~2"></span>
character(len=*),
</td>
<td>intent(in)</td>
Expand Down Expand Up @@ -212,7 +215,7 @@ <h4>
</div>

<div class="card">
<div class="card-header codesum"><span class="anchor" id="proc-fnv_1a_string_t"></span><h3>private pure function fnv_1a_string_t(input, seed) result(hash)
<div class="card-header codesum"><span class="anchor" id="proc-fnv_1a_string_t"></span> <h3>private pure function fnv_1a_string_t(input, seed) result(hash)
</h3></div>
<div class="card-body">
<p>Hash a string_t array of default kind</p>
Expand All @@ -230,7 +233,7 @@ <h4>Arguments</h4>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-input~2"></span>
<span class="anchor" id="variable-input~3"></span>
type(<a href='../type/string_t.html'>string_t</a>),
</td>
<td>intent(in)</td>
Expand Down Expand Up @@ -277,14 +280,14 @@ <h4>
<footer>
<div class="container">
<div class="row justify-content-between">
<div class="col"><p>Fortran-lang/fpm was developed by fortran-lang/fpm contributors<br>&copy; 2023
<div class="col"><p>Fortran-lang/fpm was developed by fortran-lang/fpm contributors<br>&copy; 2024
</p>
</div>
<div class="col">
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-12-28 16:08 </p>
on 2024-01-08 09:21 </p>
</div>
</div>
<br>
Expand Down
Loading

0 comments on commit c263334

Please sign in to comment.