Skip to content

Commit aa3e624

Browse files
committed
Update developer docs for changes to how markdown is processed
1 parent e1c1e7f commit aa3e624

File tree

4 files changed

+15
-7
lines changed

4 files changed

+15
-7
lines changed

docs/api/ford._markdown.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ford._markdown module
2+
==========================
3+
4+
.. automodule:: ford._markdown
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/api/ford.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Submodules
1717
ford.fortran_project
1818
ford.graphs
1919
ford.intrinsics
20+
ford._markdown
2021
ford.md_admonition
2122
ford.md_environ
2223
ford.md_striped_table

docs/developers_guide/index.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,19 @@ This is a very rough outline of how FORD works internally.
4949
#. After each file has been parsed, the lists of entities are added to
5050
the `Project`'s lists of all the entities in the whole project.
5151

52-
#. After all the files have been parsed, the documentation comments are
53-
converted from Markdown to HTML, recursively down from the source
54-
files. At this point, metadata in the comments is also parsed.
55-
5652
#. Entities defined in other files are now "correlated" with their
5753
concrete objects. This is done recursively from
5854
`Project.correlate`, first by finding which modules are ``use``\ d
5955
by each entity, and then looking up names in the corresponding
6056
`FortranModule`.
6157

62-
#. Another recursive pass is done of the project to convert internal
63-
`links <writing-links>` to actual HTML links using `sub_links`.
58+
#. After all the files have been parsed, the documentation comments
59+
are converted from Markdown to HTML, recursively down from the
60+
source files. At this point, metadata in the comments is also
61+
parsed. Several markdown extensions, `AliasPreprocessor`,
62+
`FordLinkProcessor`, `RelativeLinksTreeProcessor`, handle aliases,
63+
links, and absolute to relative link conversion respectively. The
64+
`MetaMarkdown` class just wraps constructing the markdown object.
6465

6566
#. The static pages are processed with `get_page_tree`.
6667

ford/_markdown.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ def __init__(
5151
aliases: Optional[Dict[str, str]] = None,
5252
project: Optional[Project] = None,
5353
):
54-
"""make thing"""
5554

5655
default_extensions: List[Union[str, Extension]] = [
5756
"markdown_include.include",

0 commit comments

Comments
 (0)