Merge pull request #573 from Fortran-FOSS-Programmers/update-docs-for…

…-toml

Update docs for setting options in `fpm.toml`

docs/_static/ford_docs_custom.css

@@ -0,0 +1,4 @@
+/* Fixes issue with using sphinx-inline-tabs with sphinx-book-theme */
+.tab-content.docutils.container {
+    width: 100%;
+}

docs/conf.py

@@ -26,6 +26,7 @@
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
     "sphinx_argparse_cli",
+    "sphinx_inline_tabs",
 ]
 
 # Napoleon settings
@@ -53,6 +54,7 @@
 
 html_theme = "sphinx_book_theme"
 html_static_path = ["_static"]
+html_css_files = ["ford_docs_custom.css"]
 
 html_context = {
     "github_user": "Fortran-FOSS-Programmers",

docs/user_guide/command_line_options.rst

@@ -4,6 +4,19 @@
  Command Line Options
 ======================
 
+As well as setting options in the `project file <sec-project-options>`, you can
+set or override all of them on the command line. This is useful for integrating
+Ford into a build system for setting preprocessor defines, include paths, or
+the version number, for example.
+
+.. versionadded:: 7.0
+   The ``--config`` flag can be used to set *any* option. It takes a
+   TOML-formatted, semi-colon separated string, for example:
+
+   .. code:: console
+
+      ford example-project-file.md --config="search=false; parallel=4"
+
 .. sphinx_argparse_cli::
    :module: ford
    :func: get_command_line_arguments

docs/user_guide/getting_started.rst

@@ -24,6 +24,10 @@ Here's a simple project file, ``my_project.md``
 
     This is my Fortran project!
 
+.. versionadded:: 7.0
+   If you use `fpm <https://fpm.fortran-lang.org>`_, you can also
+   specify project metadata in your `fpm.toml file <sec-fpm-toml>`!
+
 We'll also need some Fortran source code to document. By default, FORD
 looks for ``.f90`` files (along with `other extensions
 <option-extensions>`) in ``./src`` -- this is relative to where you