diff --git a/docs/documentation/api/modes.md b/docs/documentation/api/modes.md new file mode 100644 index 0000000..d4ecf28 --- /dev/null +++ b/docs/documentation/api/modes.md @@ -0,0 +1 @@ +::: intrinsic.modes diff --git a/docs/documentation/examples.md b/docs/documentation/examples.md new file mode 100644 index 0000000..df635b4 --- /dev/null +++ b/docs/documentation/examples.md @@ -0,0 +1 @@ +# Examples diff --git a/docs/documentation/getting_started.md b/docs/documentation/getting_started.md new file mode 100644 index 0000000..ac3a488 --- /dev/null +++ b/docs/documentation/getting_started.md @@ -0,0 +1,11 @@ +# Getting Started + +Welcome to the `Getting Started` guide for **My Project**. + +## Installation + +To install the project, run: + +```bash +pip install my-project +``` diff --git a/docs/documentation/index.md b/docs/documentation/index.md new file mode 100644 index 0000000..a335013 --- /dev/null +++ b/docs/documentation/index.md @@ -0,0 +1,11 @@ +# Finite Element models 4 Intrinsic Nonlinear Aeroelastics in JAX [FENIAX] + +FEM4INAS is an aeroelastic toolbox written and parallelized in Python, which acts as a post-processor of commercial software such as MSC Nastran. +Arbitrary FE models built for linear aeroelastic analysis are enhanced with geometric nonlinear effects, flight dynamics and linearized state-space solutions about nonlinear equilibrium. + + +## t1 + +fsdf + +### t3 diff --git a/docs/documentation/requirements.txt b/docs/documentation/requirements.txt new file mode 100644 index 0000000..01b87dd --- /dev/null +++ b/docs/documentation/requirements.txt @@ -0,0 +1,8 @@ +# Latest versions at time of writing. +mkdocs # Main documentation generator. +mkdocs-material # Theme +pymdown-extensions # Markdown extensions e.g. to handle LaTeX. +mkdocstrings # Autogenerate documentation from docstrings. +mknotebooks # Turn Jupyter Lab notebooks into webpages. +pytkdocs_tweaks # Tweaks mkdocstrings to improve various aspects +mkdocs_include_exclude_files # Allow for customising which files get included diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..8706c71 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,119 @@ +site_name: FENIAX +site_description: Documentation for aeroelastic library FENIAX. +site_author: Alvaro Cea +docs_dir: docs/documentation + +repo_url: https://github.com/ACea15/FENIAX +repo_name: ACea15/FENIAX +edit_uri: "" # No edit button, as some of our pages are in /docs and some in /examples via symlink, so it's impossible for them all to be accurate +strict: False # Don't allow warnings during the build process + +theme: + name: material + features: + # - navigation.sections # Sections are included in the navigation on the left. + # - toc.integrate # Table of contents is integrated on the left; does not appear separately on the right. + # - header.autohide # header disappears as you scroll + - announce.dismiss + - content.action.edit + - content.action.view + - content.code.annotate + - content.code.copy + # - content.code.select + # - content.footnote.tooltips + # - content.tabs.link + - content.tooltips + # - header.autohide + # - navigation.expand + - navigation.footer + - navigation.indexes + # - navigation.instant + # - navigation.instant.prefetch + # - navigation.instant.progress + # - navigation.prune + - navigation.sections + - navigation.tabs + - navigation.tabs.sticky + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow + # - toc.integrate + palette: + # Light mode / dark mode + # We deliberately don't automatically use `media` to check a user's preferences. We default to light mode as + # (a) it looks more professional, and (b) is more obvious about the fact that it offers a (dark mode) toggle. + - scheme: default + primary: white + accent: amber + toggle: + icon: material/weather-night + name: Switch to dark mode + - scheme: slate + primary: black + accent: amber + toggle: + icon: material/weather-sunny + name: Switch to light mode + icon: + repo: fontawesome/brands/github # GitHub logo in top right + # logo: "material/math-integral-box" # logo in top left + +markdown_extensions: + - pymdownx.arithmatex: # Render LaTeX via MathJax + generic: true + - pymdownx.superfences # Seems to enable syntax highlighting when used with the Material theme. + - pymdownx.details # Allowing hidden expandable regions denoted by ??? + - pymdownx.snippets: # Include one Markdown file into another + base_path: docs + - admonition + - toc: + permalink: "ยค" # Adds a clickable permalink to each section heading + toc_depth: 4 # Prevents h5, h6 (i.e. methods) from showing up in the TOC. + +plugins: + - search # default search plugin; needs manually re-enabling when using any other plugins + - autorefs # Cross-links to headings + - include_exclude_files: + include: + # exclude: + # - "_overrides" + # - "_static/README.md" + - mknotebooks # Jupyter notebooks + - mkdocstrings: + default_handler: python + handlers: + python: + paths: [fem4inas] + options: + docstring_style: numpy # 'google' 'numpy', 'rst', etc. + filters: ["!^_[^_]"] # Exclude private members + show_root_full_path: true + # setup_commands: + # - import pytkdocs_tweaks + # - pytkdocs_tweaks.main() + + selection: + - inherited_members: true # Allow looking up inherited methods + rendering: + - show_root_heading: true # actually display anything at all... + - show_root_full_path: true # display "diffrax.asdf" not just "asdf" + - show_if_no_docstring: true + - show_signature_annotations: true + - show_source: false # don't include source code + - members_order: source # order methods according to their order of definition in the source code, not alphabetical order + - heading_level: 4 # Makes everything top-level be

. Child entries will be

etc., but because of toc_depth, above, (deliberately) won't appear in the TOC. + +nav: + - Home: index.md + # - Getting started + # - Installation: + # - Theoretical Background: + # - Running: + #- Tutorials + - Examples: examples.md + #- Postprocessing + - Codes: + - Modes: api/modes.md