├── site ├── content ├── .gitignore └── .gitattributes ├── pelican-theme ├── test │ ├── .gitignore │ ├── blog │ │ ├── ship.jpg │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── page_minimal │ │ └── page.rst │ ├── layout │ │ ├── features.rst │ │ ├── guest-post-howto.rst │ │ └── showcase-requirements.rst │ ├── page_cover │ │ ├── ship.jpg │ │ └── page.rst │ ├── page_landing │ │ ├── ship.jpg │ │ ├── hide-navbar-brand-no-cover.rst │ │ ├── hide-navbar-brand.rst │ │ └── page.rst │ ├── page_global_social_meta │ │ └── page.rst │ ├── page_title_sitename_alias │ │ └── page.rst │ ├── blog_pagination_disabled │ │ ├── article1.rst │ │ ├── article2.rst │ │ └── article3.rst │ ├── layout_brand_logo │ │ ├── mosra.jpg │ │ └── index.rst │ ├── blog_minimal │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_author_list │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_news_on_index │ │ ├── article.rst │ │ ├── pages │ │ │ └── index.rst │ │ ├── article3.rst │ │ └── article2.rst │ ├── blog_modified_date │ │ ├── article2.rst │ │ └── article.rst │ ├── .gitattributes │ ├── blog_draft │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── page_breadcrumb │ │ ├── page.rst │ │ └── subpage.rst │ ├── blog_feeds │ │ └── article.rst │ ├── blog_feeds_no_url │ │ └── article.rst │ ├── blog_footer_links │ │ ├── article.rst │ │ └── article2.rst │ ├── blog_archived_article │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_jumbo_inverted │ │ └── article-jumbo.rst │ ├── blog_pagination │ │ ├── article1.rst │ │ ├── article2.rst │ │ └── article3.rst │ ├── blog_collapse_first_global │ │ ├── article.rst │ │ └── article2.rst │ ├── blog_global_social_meta │ │ └── article.rst │ ├── page_html_escape │ │ ├── breadcrumb.rst │ │ ├── landing.rst │ │ ├── page.rst │ │ └── content.rst │ ├── blog_collapse_first_article │ │ ├── article.rst │ │ └── article2.rst │ ├── blog_collapse_first_both │ │ ├── article.rst │ │ └── article2.rst │ ├── blog_author_list_tags │ │ └── article-jumbo.rst │ ├── blog_collapse_first_global_hide_summary_global │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── page │ │ └── page.rst │ ├── blog_collapse_first_article_hide_summary_global │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_collapse_first_global_hide_summary_article │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_collapse_first_both_hide_summary_global │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_hide_summary_both │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── page_header_footer │ │ └── page.rst │ ├── blog_collapse_first_global_hide_summary_both │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_hide_summary_global │ │ ├── article-jumbo.rst │ │ └── article.rst │ ├── blog_hide_summary_article │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_collapse_first_article_hide_summary_article │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_collapse_first_both_hide_summary_article │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_collapse_first_article_hide_summary_both │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── blog_collapse_first_both_hide_summary_both │ │ ├── article.rst │ │ └── article-jumbo.rst │ ├── page_extra_html_head │ │ └── page.rst │ ├── blog_html_escape │ │ ├── article.rst │ │ └── article-jumbo.rst │ └── page_passthrough │ │ ├── page.html │ │ └── input │ │ └── page.html ├── static │ ├── m-dark.css │ ├── m-debug.css │ ├── m-grid.css │ ├── m-light.css │ ├── m-layout.css │ ├── m-components.css │ ├── m-theme-dark.css │ ├── m-theme-light.css │ ├── pygments-dark.css │ ├── m-dark.compiled.css │ ├── m-light.compiled.css │ └── pygments-console.css └── templates │ ├── index.html │ └── pagination.html ├── plugins ├── m │ ├── test │ │ ├── .gitignore │ │ ├── images │ │ │ ├── ship.jpg │ │ │ ├── flowers.jpg │ │ │ ├── noexif.jpg │ │ │ ├── tiny.png │ │ │ ├── sparseexif.jpg │ │ │ └── longexposure.jpg │ │ ├── metadata │ │ │ ├── tags │ │ │ │ ├── minimal-tag.rst │ │ │ │ └── a-tag.rst │ │ │ ├── category.jpg │ │ │ ├── mosra.jpg │ │ │ ├── authors │ │ │ │ ├── minimal-author.rst │ │ │ │ ├── author-with-no-image.rst │ │ │ │ └── an-author.rst │ │ │ ├── categories │ │ │ │ ├── minimal-category.rst │ │ │ │ ├── category-with-no-image.rst │ │ │ │ └── a-category.rst │ │ │ └── articles │ │ │ │ ├── article-no-image.rst │ │ │ │ ├── article.rst │ │ │ │ ├── article-jumbo.rst │ │ │ │ └── article-minimal.rst │ │ ├── code │ │ │ ├── style.css │ │ │ ├── code.cpp │ │ │ ├── console.ansi │ │ │ └── ansi.rst │ │ ├── htmlsanity_parse_error │ │ │ └── page.rst │ │ ├── .gitattributes │ │ ├── alias │ │ │ ├── page.rst │ │ │ ├── articles │ │ │ │ └── article.rst │ │ │ ├── even-older-page.html │ │ │ ├── old-page │ │ │ │ └── index.html │ │ │ └── blog │ │ │ │ └── old-article │ │ │ │ └── index.html │ │ ├── abbr │ │ │ └── page.rst │ │ ├── htmlsanity_typography_global_lang │ │ │ └── page.rst │ │ ├── htmlsanity_typography │ │ │ ├── articles │ │ │ │ ├── jumbo.rst │ │ │ │ └── lang.rst │ │ │ └── page-lang.rst │ │ ├── metadata_typography_html_escape │ │ │ ├── articles │ │ │ │ └── article.rst │ │ │ ├── tags │ │ │ │ └── a-tag.rst │ │ │ ├── authors │ │ │ │ └── an-author.rst │ │ │ └── categories │ │ │ │ └── a-category.rst │ │ ├── link │ │ │ └── page.rst │ │ ├── math_cached │ │ │ └── page.rst │ │ ├── math_uncached │ │ │ └── page.rst │ │ ├── filesize │ │ │ └── page.rst │ │ ├── vk │ │ │ └── page.rst │ │ ├── gl │ │ │ └── page.rst │ │ ├── qr │ │ │ └── page.rst │ │ └── gh │ │ │ └── page.rst │ └── .gitignore └── .coveragerc ├── .circleci └── config.yml ├── documentation ├── test_python │ ├── layout │ │ ├── sitemap.xml │ │ ├── about.rst │ │ ├── getting-started.rst │ │ └── troubleshooting.rst │ ├── inspect_object │ │ └── .gitkeep │ ├── stubs_spacing │ │ ├── empty_module.py │ │ └── stubs_spacing.rst │ ├── inspect_all_property │ │ └── inspect_all_property │ │ │ ├── hidden.py │ │ │ └── _private_but_exposed.py │ ├── page_input_subdir │ │ └── sub │ │ │ └── index.rst │ ├── inspect_string │ │ ├── stubs │ │ │ └── inspect_string │ │ │ │ ├── another_module.pyi │ │ │ │ └── subpackage │ │ │ │ └── inner.pyi │ │ └── inspect_string │ │ │ ├── subpackage │ │ │ ├── __init__.py │ │ │ └── inner.py │ │ │ └── another_module.py │ ├── search │ │ └── search │ │ │ ├── sub.py │ │ │ └── __init__.py │ ├── inspect_underscored │ │ └── inspect_underscored │ │ │ ├── _submodule_external.py │ │ │ ├── _submodule_undocumented.py │ │ │ └── _submodule.py │ ├── page_plugins │ │ ├── tiny.png │ │ ├── subdir │ │ │ └── tiny.png │ │ ├── dot.rst │ │ └── plots.rst │ ├── layout_project_logo │ │ └── mosra.jpg │ ├── link_formatting │ │ ├── tiny.png │ │ ├── link_formatting │ │ │ ├── sub.py │ │ │ └── __init__.py │ │ └── page.rst │ ├── stubs_custom_header_extension │ │ ├── stubs_custom_header_extension │ │ │ ├── sub.py │ │ │ └── __init__.py │ │ └── stubs │ │ │ └── stubs_custom_header_extension │ │ │ ├── sub.custom.py │ │ │ └── __init__.custom.py │ ├── content │ │ ├── content │ │ │ ├── submodule.py │ │ │ └── docstring_summary.py │ │ └── page.rst │ ├── stubs_module_dependencies │ │ ├── another_module.py │ │ ├── stubs_module_dependencies │ │ │ ├── sub │ │ │ │ ├── __init__.py │ │ │ │ └── inner.py │ │ │ └── pybind.cpp │ │ ├── stubs │ │ │ └── stubs_module_dependencies │ │ │ │ ├── pybind │ │ │ │ └── __init__.py │ │ │ │ └── sub │ │ │ │ └── inner.py │ │ ├── unparsed_module.py │ │ └── unparsed_enum_module.py │ ├── layout_project_logo_main_project_url │ │ └── mosra.jpg │ ├── page │ │ ├── index.rst │ │ ├── error.rst │ │ └── another.rst │ ├── inspect_create_intersphinx │ │ ├── page.rst │ │ └── inspect_create_intersphinx │ │ │ ├── pybind.cpp │ │ │ └── __init__.py │ ├── pybind_submodules_package │ │ ├── pybind_submodules_package │ │ │ └── __init__.py │ │ └── sub.cpp │ ├── content_html_escape │ │ ├── stubs │ │ │ └── content_html_escape │ │ │ │ └── pybind.pyi │ │ ├── page.rst │ │ └── content_html_escape │ │ │ └── pybind.cpp │ ├── pybind_name_mapping │ │ ├── stubs │ │ │ └── pybind_name_mapping │ │ │ │ ├── submodule.py │ │ │ │ └── __init__.py │ │ ├── pybind_name_mapping │ │ │ └── __init__.py │ │ └── sub.cpp │ ├── inspect_duplicate_class │ │ └── inspect_duplicate_class │ │ │ ├── sub.py │ │ │ └── __init__.py │ ├── inspect_name_mapping │ │ ├── stubs │ │ │ └── inspect_name_mapping │ │ │ │ ├── submodule.py │ │ │ │ └── __init__.py │ │ └── inspect_name_mapping │ │ │ ├── _sub │ │ │ ├── __init__.py │ │ │ └── bar.py │ │ │ └── __init__.py │ ├── pybind_signatures │ │ ├── false_positives.py │ │ └── stubs │ │ │ └── pybind_signatures │ │ │ └── just_overloads.pyi │ ├── inspect_recursive │ │ └── inspect_recursive │ │ │ ├── first.py │ │ │ ├── second.py │ │ │ └── __init__.py │ ├── pybind_enums │ │ ├── docs.rst │ │ └── stubs │ │ │ └── pybind_enums.pyi │ ├── inspect_builtin │ │ ├── docs.rst │ │ ├── inspect_builtin.py │ │ └── stubs │ │ │ ├── inspect_builtin-36.pyi │ │ │ ├── inspect_builtin-310.pyi │ │ │ └── inspect_builtin.pyi │ ├── pybind_submodules │ │ └── pybind_submodules.cpp │ ├── pybind_broken_signatures │ │ ├── pybind_broken_signatures │ │ │ └── __init__.py │ │ └── stubs │ │ │ └── pybind_broken_signatures.pyi │ ├── inspect_type_links │ │ ├── inspect_type_links │ │ │ ├── __init__.py │ │ │ └── first │ │ │ │ └── sub.py │ │ └── index.rst │ ├── layout_search_open_search │ │ └── opensearch.xml │ ├── stubs_nested_classes │ │ └── stubs_nested_classes.py │ └── inspect_value_formatting │ │ └── stubs │ │ └── inspect_value_formatting.pyi ├── test_doxygen │ ├── page_empty_index │ │ ├── input.dox │ │ └── Doxyfile │ ├── page_empty_page │ │ ├── subdir │ │ │ └── otherinput.md │ │ ├── input.h │ │ ├── Doxyfile │ │ └── input.md │ ├── doxyfile │ │ ├── Doxyfile-subdirs │ │ ├── Doxyfile-another │ │ ├── Doxyfile │ │ └── Doxyfile-legacy │ ├── layout_minimal │ │ ├── Doxyfile │ │ └── indexpage.xml │ ├── search │ │ ├── example.cpp │ │ ├── UndocumentedDir │ │ │ └── UndocumentedFile.h │ │ └── input.dox │ ├── contents_custom │ │ ├── ship-small.jpg │ │ └── ab.dot │ ├── contents_image │ │ ├── tiny.png │ │ └── Doxyfile │ ├── contents_html_escape │ │ ├── tiny.png │ │ └── Doxyfile │ ├── example │ │ ├── a.txt │ │ ├── path-prefix │ │ │ ├── configure.h.cmake │ │ │ ├── main.cpp │ │ │ └── CMakeLists.txt │ │ └── input.dox │ ├── ignored_xmls │ │ ├── Doxyfile.xml │ │ ├── broken.xml │ │ ├── index.xml │ │ ├── Foxydile.xml │ │ ├── Doxyfile │ │ └── thingsgotcrazy.xml │ ├── layout_navbar_project_logo │ │ ├── mosra.jpg │ │ ├── Doxyfile │ │ └── indexpage.xml │ ├── contents_dot │ │ ├── ab.dot │ │ ├── colors.dot │ │ └── input.dox │ ├── page_empty_title │ │ ├── input.dox │ │ └── Doxyfile │ ├── compound_deprecated │ │ ├── Dir │ │ │ └── DeprecatedSubdir │ │ │ │ └── File.h │ │ ├── deprecated-page.dox │ │ └── Doxyfile │ ├── compound_listing │ │ ├── Root.h │ │ ├── Another │ │ │ └── Some.h │ │ ├── TopLevelFile.h │ │ ├── Doxyfile-strip-from-path │ │ └── input.dox │ ├── doxyfile_upgrade_custom_variables │ │ └── .gitignore │ ├── ignored_languages │ │ ├── file.cs │ │ ├── file.java │ │ ├── file.py │ │ ├── file.c │ │ └── Doxyfile │ ├── layout_navbar_project_logo_main_project_url │ │ ├── mosra.jpg │ │ ├── Doxyfile │ │ └── indexpage.xml │ ├── page_order │ │ ├── 02-last.dox │ │ ├── 01-second.dox │ │ ├── a-subpage.dox │ │ ├── other-page.dox │ │ ├── 00-page-order.dox │ │ ├── yet-another-subpage.dox │ │ ├── 03-first.dox │ │ └── Doxyfile │ ├── compound_no_full_path_names │ │ ├── project │ │ │ ├── directory │ │ │ │ └── sub.h │ │ │ └── root.h │ │ └── doc │ │ │ └── Doxyfile │ ├── contents_code_language │ │ ├── code.sh │ │ ├── snippet.cpp │ │ ├── Doxyfile │ │ └── console-colors.ansi │ ├── contents_autobrief_heading │ │ ├── File.h │ │ └── Doxyfile │ ├── page_subpage_of_index │ │ ├── input.dox │ │ └── Doxyfile │ ├── compound_ignored │ │ ├── File.cpp │ │ ├── File.h │ │ └── Doxyfile │ ├── contents_htmlonly_htmlinclude │ │ ├── file.html │ │ ├── input.dox │ │ └── Doxyfile │ ├── contents_autobrief_multiline │ │ ├── File.h │ │ └── Doxyfile │ ├── page_in_navbar │ │ ├── input.dox │ │ └── Doxyfile │ ├── compound_includes │ │ ├── First.cpp │ │ └── Doxyfile │ ├── layout │ │ └── index.xml │ ├── compound_includes_templated │ │ ├── Second.h │ │ ├── Doxyfile │ │ └── First.h │ ├── contents_section_underscore_one │ │ ├── input.dox │ │ └── Doxyfile │ ├── contents_internal │ │ ├── input.dox │ │ └── Doxyfile │ ├── page_brief │ │ ├── input.dox │ │ └── Doxyfile │ ├── layout_template_fallback │ │ ├── Doxyfile │ │ ├── indexpage.xml │ │ └── page.html │ ├── contents_autobrief_hr │ │ ├── File.h │ │ └── Doxyfile │ ├── contents_anchor_html_no_prefix_bug │ │ ├── input.dox │ │ └── Doxyfile │ ├── contents_brief_multiline_ingroup │ │ ├── File.h │ │ └── Doxyfile │ ├── layout_search_binary │ │ ├── Doxyfile │ │ └── indexpage.xml │ ├── contents_autobrief_blockquote │ │ ├── File.h │ │ └── Doxyfile │ ├── contents_code_filters │ │ ├── input.dox │ │ └── Doxyfile │ ├── contents_tagfile │ │ ├── input.dox │ │ └── Doxyfile │ ├── page_footer_navigation │ │ ├── input.dox │ │ └── Doxyfile │ ├── compound_exception_reference │ │ ├── File.h │ │ └── Doxyfile │ ├── compound_filename_case │ │ ├── input.h │ │ └── Doxyfile │ ├── layout_navbar_main_project_url │ │ ├── Doxyfile │ │ └── indexpage.xml │ ├── page_toc │ │ ├── input.dox │ │ └── Doxyfile │ ├── compound_includes_strip_from_path │ │ ├── project │ │ │ └── examples │ │ │ │ └── example.cpp │ │ └── input.dox │ ├── compound_inline_namespace │ │ ├── File.h │ │ └── Doxyfile │ ├── layout_navbar_single_column │ │ ├── Doxyfile │ │ └── indexpage.xml │ ├── layout_search_opensearch │ │ ├── Doxyfile │ │ ├── opensearch.xml.html │ │ └── indexpage.xml │ ├── contents_autobrief_cpp_comments │ │ ├── File.h │ │ └── Doxyfile │ ├── compound_base_template_classes │ │ ├── File.h │ │ └── Doxyfile │ ├── contents_blocks │ │ ├── File.h │ │ └── Doxyfile │ ├── contents_anchor_in_both_group_and_namespace │ │ ├── File.h │ │ └── Doxyfile │ ├── contents_math_code_fallback │ │ ├── input.dox │ │ └── Doxyfile │ ├── compound_modules │ │ └── Doxyfile │ ├── contents_blockquote │ │ └── Doxyfile │ ├── contents_typography │ │ └── Doxyfile │ ├── compound_crazy_template_params │ │ ├── Doxyfile │ │ └── File.h │ ├── contents_unexpected_sections │ │ ├── Doxyfile │ │ └── File.h │ ├── search_long_suffix_length │ │ ├── Doxyfile │ │ └── File.h │ ├── cpp_enum │ │ ├── Doxyfile │ │ └── File.h │ ├── cpp_friends │ │ └── Doxyfile │ ├── contents_code │ │ └── Doxyfile │ ├── contents_math │ │ ├── Doxyfile │ │ └── input.dox │ ├── contents_sections_headings │ │ ├── Doxyfile │ │ ├── File.h │ │ ├── Warnings.h │ │ └── input.dox │ ├── cpp_derived │ │ └── Doxyfile │ ├── compound_detailed │ │ └── Doxyfile │ ├── cpp_template_alias │ │ └── Doxyfile │ ├── cpp_mishandled_macro_call │ │ └── Doxyfile │ ├── cpp_signals_slots │ │ └── Doxyfile │ ├── cpp_variable_template │ │ └── Doxyfile │ ├── layout_navbar_html │ │ ├── indexpage.xml │ │ └── Doxyfile │ ├── contents_math_cached │ │ └── Doxyfile │ ├── cpp_function_attributes_nospace │ │ ├── Doxyfile │ │ └── input.h │ ├── layout_generated_doxyfile │ │ └── xml │ │ │ └── indexpage.xml │ ├── compound_base_derived_in_root_namespace │ │ ├── Doxyfile │ │ └── File.h │ ├── compound_namespace_members_in_file_scope │ │ └── Doxyfile │ ├── compound_modules_in_namespace │ │ ├── Doxyfile │ │ ├── file3.h │ │ └── file2.h │ ├── compound_namespace_members_in_file_scope_define_base_url │ │ ├── Doxyfile │ │ └── File.h │ ├── compound_includes_undocumented_files │ │ └── Doxyfile │ ├── cpp_function_variable_attributes │ │ └── Doxyfile │ ├── undocumented │ │ └── Doxyfile │ └── compound_includes_disabled │ │ └── Doxyfile ├── test │ └── js-test-data │ │ ├── short.bin │ │ ├── wrong-magic.bin │ │ ├── wrong-version.bin │ │ ├── empty-ns1-ri2-fo3.bin │ │ ├── empty-ns1-ri2-fo4.bin │ │ ├── empty-ns1-ri3-fo3.bin │ │ ├── empty-ns1-ri3-fo4.bin │ │ ├── empty-ns1-ri4-fo3.bin │ │ ├── empty-ns1-ri4-fo4.bin │ │ ├── empty-ns2-ri2-fo3.bin │ │ ├── empty-ns2-ri2-fo4.bin │ │ ├── empty-ns2-ri3-fo3.bin │ │ ├── empty-ns2-ri3-fo4.bin │ │ ├── empty-ns2-ri4-fo3.bin │ │ ├── empty-ns2-ri4-fo4.bin │ │ ├── wrong-result-id-bytes.bin │ │ ├── nested.bin │ │ ├── unicode.bin │ │ ├── manyresults-ns1-ri2-fo3.bin │ │ ├── manyresults-ns1-ri2-fo4.bin │ │ ├── manyresults-ns1-ri3-fo3.bin │ │ ├── manyresults-ns1-ri3-fo4.bin │ │ ├── manyresults-ns1-ri4-fo3.bin │ │ ├── manyresults-ns1-ri4-fo4.bin │ │ ├── manyresults-ns2-ri2-fo3.bin │ │ ├── manyresults-ns2-ri2-fo4.bin │ │ ├── manyresults-ns2-ri3-fo3.bin │ │ ├── manyresults-ns2-ri3-fo4.bin │ │ ├── manyresults-ns2-ri4-fo3.bin │ │ ├── manyresults-ns2-ri4-fo4.bin │ │ ├── searchdata-ns1-ri2-fo3.bin │ │ ├── searchdata-ns1-ri2-fo4.bin │ │ ├── searchdata-ns1-ri3-fo3.bin │ │ ├── searchdata-ns1-ri3-fo4.bin │ │ ├── searchdata-ns1-ri4-fo3.bin │ │ ├── searchdata-ns1-ri4-fo4.bin │ │ ├── searchdata-ns2-ri2-fo3.bin │ │ ├── searchdata-ns2-ri2-fo4.bin │ │ ├── searchdata-ns2-ri3-fo3.bin │ │ ├── searchdata-ns2-ri3-fo4.bin │ │ ├── searchdata-ns2-ri4-fo3.bin │ │ ├── searchdata-ns2-ri4-fo4.bin │ │ └── .gitattributes ├── templates │ ├── doxygen │ │ ├── class.html │ │ ├── union.html │ │ ├── struct.html │ │ ├── entry-dir.html │ │ ├── entry-file.html │ │ ├── entry-module.html │ │ ├── entry-namespace.html │ │ ├── opensearch.xml │ │ ├── group.html │ │ ├── file.html │ │ └── dir.html │ └── python │ │ ├── entry-class.html │ │ ├── entry-module.html │ │ ├── entry-data.html │ │ ├── opensearch.xml │ │ ├── details-data.html │ │ ├── page.html │ │ ├── entry-property.html │ │ └── entry-enum.html ├── .coveragerc ├── favicon-dark.png ├── favicon-light.png ├── .gitattributes ├── .istanbul.yml └── .gitignore ├── .gitignore ├── doc ├── static │ ├── m-dark.documentation.compiled.css │ ├── ship.jpg │ ├── site.jpg │ ├── cover.jpg │ ├── favicon.ico │ ├── flowers.jpg │ ├── mosra.jpg │ ├── cover-math.jpg │ ├── ship-small.jpg │ ├── flowers-small.jpg │ └── opengl-search.png ├── documentation │ └── python.inv ├── examples │ ├── tags │ │ └── jumbo.rst │ ├── authors │ │ └── an-author.rst │ └── categories │ │ └── examples.rst └── plugins │ ├── math-and-code-snippet.cpp │ ├── math-and-code-console-colors.ansi │ ├── math-and-code-selfcontained.py │ └── math-and-code-console.ansi ├── .editorconfig ├── .gitattributes ├── artwork └── README.rst └── css └── postprocess.sh /site/content: -------------------------------------------------------------------------------- 1 | ../doc/ -------------------------------------------------------------------------------- /pelican-theme/test/.gitignore: -------------------------------------------------------------------------------- 1 | */output/ 2 | -------------------------------------------------------------------------------- /plugins/m/test/.gitignore: -------------------------------------------------------------------------------- 1 | */output/ 2 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | ../package/ci/circleci.yml -------------------------------------------------------------------------------- /documentation/test_python/layout/sitemap.xml: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_index/input.dox: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_object/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pelican-theme/static/m-dark.css: -------------------------------------------------------------------------------- 1 | ../../css/m-dark.css -------------------------------------------------------------------------------- /pelican-theme/static/m-debug.css: -------------------------------------------------------------------------------- 1 | ../../css/m-debug.css -------------------------------------------------------------------------------- /pelican-theme/static/m-grid.css: -------------------------------------------------------------------------------- 1 | ../../css/m-grid.css -------------------------------------------------------------------------------- /pelican-theme/static/m-light.css: -------------------------------------------------------------------------------- 1 | ../../css/m-light.css -------------------------------------------------------------------------------- /site/.gitignore: -------------------------------------------------------------------------------- 1 | *.pid 2 | output 3 | published 4 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_spacing/empty_module.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pelican-theme/static/m-layout.css: -------------------------------------------------------------------------------- 1 | ../../css/m-layout.css -------------------------------------------------------------------------------- /plugins/m/.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | test/*/math.cache 3 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_spacing/stubs_spacing.rst: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /pelican-theme/static/m-components.css: -------------------------------------------------------------------------------- 1 | ../../css/m-components.css -------------------------------------------------------------------------------- /pelican-theme/static/m-theme-dark.css: -------------------------------------------------------------------------------- 1 | ../../css/m-theme-dark.css -------------------------------------------------------------------------------- /pelican-theme/test/blog/ship.jpg: -------------------------------------------------------------------------------- 1 | ../../../doc/static/ship.jpg -------------------------------------------------------------------------------- /pelican-theme/test/page_minimal/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | -------------------------------------------------------------------------------- /plugins/m/test/images/ship.jpg: -------------------------------------------------------------------------------- 1 | ../../../../doc/static/ship.jpg -------------------------------------------------------------------------------- /plugins/m/test/metadata/tags/minimal-tag.rst: -------------------------------------------------------------------------------- 1 | Tag details. 2 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_page/subdir/otherinput.md: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /pelican-theme/static/m-theme-light.css: -------------------------------------------------------------------------------- 1 | ../../css/m-theme-light.css -------------------------------------------------------------------------------- /pelican-theme/static/pygments-dark.css: -------------------------------------------------------------------------------- 1 | ../../css/pygments-dark.css -------------------------------------------------------------------------------- /pelican-theme/test/layout/features.rst: -------------------------------------------------------------------------------- 1 | Features 2 | ######## 3 | -------------------------------------------------------------------------------- /pelican-theme/test/page_cover/ship.jpg: -------------------------------------------------------------------------------- 1 | ../../../doc/static/ship.jpg -------------------------------------------------------------------------------- /pelican-theme/test/page_landing/ship.jpg: -------------------------------------------------------------------------------- 1 | ../../../doc/static/ship.jpg -------------------------------------------------------------------------------- /plugins/m/test/code/style.css: -------------------------------------------------------------------------------- 1 | P{ 2 | COLOR:#C0FFEE; 3 | } 4 | -------------------------------------------------------------------------------- /plugins/m/test/htmlsanity_parse_error/page.rst: -------------------------------------------------------------------------------- 1 | Hello 2 | ##### 3 | -------------------------------------------------------------------------------- /plugins/m/test/images/flowers.jpg: -------------------------------------------------------------------------------- 1 | ../../../../doc/static/flowers.jpg -------------------------------------------------------------------------------- /plugins/m/test/metadata/category.jpg: -------------------------------------------------------------------------------- 1 | ../../../../doc/static/site.jpg -------------------------------------------------------------------------------- /plugins/m/test/metadata/mosra.jpg: -------------------------------------------------------------------------------- 1 | ../../../../doc/static/mosra.jpg -------------------------------------------------------------------------------- /documentation/test/js-test-data/short.bin: -------------------------------------------------------------------------------- 1 | ############################## -------------------------------------------------------------------------------- /pelican-theme/static/m-dark.compiled.css: -------------------------------------------------------------------------------- 1 | ../../css/m-dark.compiled.css -------------------------------------------------------------------------------- /pelican-theme/static/m-light.compiled.css: -------------------------------------------------------------------------------- 1 | ../../css/m-light.compiled.css -------------------------------------------------------------------------------- /pelican-theme/static/pygments-console.css: -------------------------------------------------------------------------------- 1 | ../../css/pygments-console.css -------------------------------------------------------------------------------- /pelican-theme/test/page_global_social_meta/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | -------------------------------------------------------------------------------- /plugins/m/test/code/code.cpp: -------------------------------------------------------------------------------- 1 | int main() { 2 | return 1; 3 | } 4 | -------------------------------------------------------------------------------- /documentation/test/js-test-data/wrong-magic.bin: -------------------------------------------------------------------------------- 1 | MOS -------------------------------------------------------------------------------- /documentation/test_doxygen/doxyfile/Doxyfile-subdirs: -------------------------------------------------------------------------------- 1 | CREATE_SUBDIRS = YES 2 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_all_property/inspect_all_property/hidden.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_python/page_input_subdir/sub/index.rst: -------------------------------------------------------------------------------- 1 | ../../page/index.rst -------------------------------------------------------------------------------- /plugins/.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | omit = 3 | */test/* 4 | latex2svg.py 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | htmlcov/ 3 | coverage/ 4 | .coverage 5 | *.kdev4 6 | -------------------------------------------------------------------------------- /documentation/test/js-test-data/wrong-version.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_minimal/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_string/stubs/inspect_string/another_module.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_string/stubs/inspect_string/subpackage/inner.pyi: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_python/search/search/sub.py: -------------------------------------------------------------------------------- 1 | DATA_IN_A_SUBMODULE = "hello" 2 | -------------------------------------------------------------------------------- /pelican-theme/test/page_title_sitename_alias/page.rst: -------------------------------------------------------------------------------- 1 | Site name 2 | ######### 3 | -------------------------------------------------------------------------------- /plugins/m/test/code/console.ansi: -------------------------------------------------------------------------------- 1 | ../../../../doc/plugins/math-and-code-console.ansi -------------------------------------------------------------------------------- /doc/static/m-dark.documentation.compiled.css: -------------------------------------------------------------------------------- 1 | ../../css/m-dark.documentation.compiled.css -------------------------------------------------------------------------------- /doc/static/ship.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/ship.jpg -------------------------------------------------------------------------------- /doc/static/site.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/site.jpg -------------------------------------------------------------------------------- /documentation/templates/doxygen/class.html: -------------------------------------------------------------------------------- 1 | {% extends 'base-class-reference.html' %} 2 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/union.html: -------------------------------------------------------------------------------- 1 | {% extends 'base-class-reference.html' %} 2 | -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns1-ri2-fo3.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns1-ri2-fo4.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns1-ri3-fo3.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns1-ri3-fo4.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns1-ri4-fo3.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns1-ri4-fo4.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns2-ri2-fo3.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns2-ri2-fo4.bin: -------------------------------------------------------------------------------- 1 | MCS  -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns2-ri3-fo3.bin: -------------------------------------------------------------------------------- 1 | MCS 2 |  -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns2-ri3-fo4.bin: -------------------------------------------------------------------------------- 1 | MCS  -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns2-ri4-fo3.bin: -------------------------------------------------------------------------------- 1 | MCS  -------------------------------------------------------------------------------- /documentation/test/js-test-data/empty-ns2-ri4-fo4.bin: -------------------------------------------------------------------------------- 1 | MCS  -------------------------------------------------------------------------------- /documentation/test/js-test-data/wrong-result-id-bytes.bin: -------------------------------------------------------------------------------- 1 | MCS -------------------------------------------------------------------------------- /documentation/test_doxygen/doxyfile/Doxyfile-another: -------------------------------------------------------------------------------- 1 | PROJECT_NAME = "My Pet Project" 2 | -------------------------------------------------------------------------------- /documentation/test_doxygen/search/example.cpp: -------------------------------------------------------------------------------- 1 | int main() { 2 | return 42; 3 | } 4 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_underscored/inspect_underscored/_submodule_external.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_python/page_plugins/tiny.png: -------------------------------------------------------------------------------- 1 | ../../../plugins/m/test/images/tiny.png -------------------------------------------------------------------------------- /pelican-theme/test/blog_pagination_disabled/article1.rst: -------------------------------------------------------------------------------- 1 | ../blog_pagination/article1.rst -------------------------------------------------------------------------------- /pelican-theme/test/blog_pagination_disabled/article2.rst: -------------------------------------------------------------------------------- 1 | ../blog_pagination/article2.rst -------------------------------------------------------------------------------- /pelican-theme/test/blog_pagination_disabled/article3.rst: -------------------------------------------------------------------------------- 1 | ../blog_pagination/article3.rst -------------------------------------------------------------------------------- /pelican-theme/test/layout/guest-post-howto.rst: -------------------------------------------------------------------------------- 1 | Guest post howto 2 | ################ 3 | -------------------------------------------------------------------------------- /pelican-theme/test/layout_brand_logo/mosra.jpg: -------------------------------------------------------------------------------- 1 | ../../../site/content/static/mosra.jpg -------------------------------------------------------------------------------- /doc/static/cover.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/cover.jpg -------------------------------------------------------------------------------- /doc/static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/favicon.ico -------------------------------------------------------------------------------- /doc/static/flowers.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/flowers.jpg -------------------------------------------------------------------------------- /doc/static/mosra.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/mosra.jpg -------------------------------------------------------------------------------- /documentation/templates/doxygen/struct.html: -------------------------------------------------------------------------------- 1 | {% extends 'base-class-reference.html' %} 2 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_custom/ship-small.jpg: -------------------------------------------------------------------------------- 1 | ../../../doc/static/ship-small.jpg -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_image/tiny.png: -------------------------------------------------------------------------------- 1 | ../../../plugins/m/test/images/tiny.png -------------------------------------------------------------------------------- /documentation/test_python/inspect_all_property/inspect_all_property/_private_but_exposed.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_underscored/inspect_underscored/_submodule_undocumented.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_python/layout_project_logo/mosra.jpg: -------------------------------------------------------------------------------- 1 | ../../../site/content/static/mosra.jpg -------------------------------------------------------------------------------- /documentation/test_python/link_formatting/tiny.png: -------------------------------------------------------------------------------- 1 | ../../../plugins/m/test/images/tiny.png -------------------------------------------------------------------------------- /documentation/test_python/stubs_custom_header_extension/stubs_custom_header_extension/sub.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_html_escape/tiny.png: -------------------------------------------------------------------------------- 1 | ../../../plugins/m/test/images/tiny.png -------------------------------------------------------------------------------- /documentation/test_doxygen/example/a.txt: -------------------------------------------------------------------------------- 1 | this example has no breadcrumb and also no footer nav 2 | -------------------------------------------------------------------------------- /documentation/test_doxygen/search/UndocumentedDir/UndocumentedFile.h: -------------------------------------------------------------------------------- 1 | /* Hic sunt leones. */ 2 | -------------------------------------------------------------------------------- /documentation/test_python/content/content/submodule.py: -------------------------------------------------------------------------------- 1 | # This module has an external summary 2 | -------------------------------------------------------------------------------- /documentation/test_python/layout/about.rst: -------------------------------------------------------------------------------- 1 | .. this is here only to make the LINKS_NAVBAR work 2 | -------------------------------------------------------------------------------- /documentation/test_python/page_plugins/subdir/tiny.png: -------------------------------------------------------------------------------- 1 | ../../../../plugins/m/test/images/tiny.png -------------------------------------------------------------------------------- /doc/static/cover-math.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/cover-math.jpg -------------------------------------------------------------------------------- /doc/static/ship-small.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/ship-small.jpg -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_xmls/Doxyfile.xml: -------------------------------------------------------------------------------- 1 | <> This XML is broken but isn't even opened <> 2 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_xmls/broken.xml: -------------------------------------------------------------------------------- 1 | <> This XML is broken and should get skipped <> 2 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_project_logo/mosra.jpg: -------------------------------------------------------------------------------- 1 | ../../../site/content/static/mosra.jpg -------------------------------------------------------------------------------- /documentation/test_python/link_formatting/link_formatting/sub.py: -------------------------------------------------------------------------------- 1 | """This is a nice submodule.""" 2 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/another_module.py: -------------------------------------------------------------------------------- 1 | class Another: 2 | ... 3 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_minimal/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | -------------------------------------------------------------------------------- /pelican-theme/test/layout/showcase-requirements.rst: -------------------------------------------------------------------------------- 1 | Showcase requirements 2 | ##################### 3 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/authors/minimal-author.rst: -------------------------------------------------------------------------------- 1 | :badge: Author badge. 2 | 3 | Author details. 4 | -------------------------------------------------------------------------------- /doc/documentation/python.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/documentation/python.inv -------------------------------------------------------------------------------- /doc/static/flowers-small.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/flowers-small.jpg -------------------------------------------------------------------------------- /doc/static/opengl-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/doc/static/opengl-search.png -------------------------------------------------------------------------------- /documentation/.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | omit = 3 | */test/* 4 | */test_*/* 5 | */latex2svg.py 6 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_custom/ab.dot: -------------------------------------------------------------------------------- 1 | strict graph "" { 2 | a -- b 3 | a -- b 4 | } 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_dot/ab.dot: -------------------------------------------------------------------------------- 1 | strict graph "" { 2 | a -- b 3 | a -- b 4 | } 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_xmls/index.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /documentation/test_python/layout/getting-started.rst: -------------------------------------------------------------------------------- 1 | .. this is here only to make the LINKS_NAVBAR work 2 | -------------------------------------------------------------------------------- /documentation/test_python/layout/troubleshooting.rst: -------------------------------------------------------------------------------- 1 | .. this is here only to make the LINKS_NAVBAR work 2 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_author_list/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_news_on_index/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | -------------------------------------------------------------------------------- /pelican-theme/test/layout_brand_logo/index.rst: -------------------------------------------------------------------------------- 1 | Brand Logo 2 | ########## 3 | 4 | :save_as: index.html 5 | -------------------------------------------------------------------------------- /documentation/favicon-dark.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/favicon-dark.png -------------------------------------------------------------------------------- /documentation/favicon-light.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/favicon-light.png -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_title/input.dox: -------------------------------------------------------------------------------- 1 | /** @page untitled 2 | 3 | An untitled page. 4 | */ 5 | -------------------------------------------------------------------------------- /documentation/test_python/layout_project_logo_main_project_url/mosra.jpg: -------------------------------------------------------------------------------- 1 | ../../../site/content/static/mosra.jpg -------------------------------------------------------------------------------- /pelican-theme/test/blog_modified_date/article2.rst: -------------------------------------------------------------------------------- 1 | An article 2 2 | ############ 3 | 4 | :date: 2017-12-09 5 | -------------------------------------------------------------------------------- /plugins/m/test/.gitattributes: -------------------------------------------------------------------------------- 1 | # Make the GitHub language stats bar prettier 2 | */*.html linguist-generated 3 | -------------------------------------------------------------------------------- /plugins/m/test/images/noexif.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/plugins/m/test/images/noexif.jpg -------------------------------------------------------------------------------- /plugins/m/test/images/tiny.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/plugins/m/test/images/tiny.png -------------------------------------------------------------------------------- /plugins/m/test/metadata/categories/minimal-category.rst: -------------------------------------------------------------------------------- 1 | :badge: Category badge. 2 | 3 | Category details. 4 | -------------------------------------------------------------------------------- /documentation/.gitattributes: -------------------------------------------------------------------------------- 1 | # Make the GitHub language stats bar prettier 2 | test/*/*.html linguist-generated 3 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_deprecated/Dir/DeprecatedSubdir/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_listing/Root.h: -------------------------------------------------------------------------------- 1 | /* Intentionally not documented */ 2 | 3 | namespace Root {} 4 | -------------------------------------------------------------------------------- /documentation/test_doxygen/doxyfile_upgrade_custom_variables/.gitignore: -------------------------------------------------------------------------------- 1 | Doxyfile-upgrade 2 | Doxyfile-upgrade.bak 3 | -------------------------------------------------------------------------------- /documentation/test_doxygen/example/path-prefix/configure.h.cmake: -------------------------------------------------------------------------------- 1 | #cmakedefine SAY_HELLO 2 | #cmakedefine SAY_BYE 3 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_languages/file.cs: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A C# file, should be ignored 3 | */ 4 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_project_logo_main_project_url/mosra.jpg: -------------------------------------------------------------------------------- 1 | ../../../site/content/static/mosra.jpg -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/02-last.dox: -------------------------------------------------------------------------------- 1 | /** @page 02-last Last 2 | 3 | Contents of last page. 4 | */ 5 | -------------------------------------------------------------------------------- /documentation/test_python/page/index.rst: -------------------------------------------------------------------------------- 1 | Main Page 2 | ######### 3 | 4 | This page is not shown in the page tree. 5 | -------------------------------------------------------------------------------- /pelican-theme/test/.gitattributes: -------------------------------------------------------------------------------- 1 | # Make the GitHub language stats bar prettier 2 | */*.html linguist-generated 3 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_draft/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :status: draft 6 | -------------------------------------------------------------------------------- /pelican-theme/test/page_breadcrumb/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :breadcrumb: 5 | {index} Index page 6 | -------------------------------------------------------------------------------- /plugins/m/test/alias/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :alias: 5 | /old-page/ 6 | /even-older-page.html 7 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_languages/file.java: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A JS file, should be ignored 3 | */ 4 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/01-second.dox: -------------------------------------------------------------------------------- 1 | /** @page 01-second Second 2 | 3 | Contents of second page. 4 | */ 5 | -------------------------------------------------------------------------------- /documentation/test_python/content/content/docstring_summary.py: -------------------------------------------------------------------------------- 1 | """This module retains summary from the docstring""" 2 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_underscored/inspect_underscored/_submodule.py: -------------------------------------------------------------------------------- 1 | """Documented underscored submodule""" 2 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_custom_header_extension/stubs_custom_header_extension/__init__.py: -------------------------------------------------------------------------------- 1 | from . import sub 2 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_news_on_index/pages/index.rst: -------------------------------------------------------------------------------- 1 | Main page 2 | ######### 3 | 4 | :save_as: index.html 5 | :url: 6 | -------------------------------------------------------------------------------- /plugins/m/test/images/sparseexif.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/plugins/m/test/images/sparseexif.jpg -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_languages/file.py: -------------------------------------------------------------------------------- 1 | """ @package file 2 | @brief A Python file, should be ignored 3 | """ 4 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/a-subpage.dox: -------------------------------------------------------------------------------- 1 | /** @page a-subpage A subpage 2 | 3 | Contents of a subpage. 4 | */ 5 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_feeds/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2018-09-13 5 | :category: A Category 6 | -------------------------------------------------------------------------------- /plugins/m/test/images/longexposure.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/plugins/m/test/images/longexposure.jpg -------------------------------------------------------------------------------- /documentation/test/js-test-data/nested.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/nested.bin -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_listing/Another/Some.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief Some file 3 | */ 4 | 5 | namespace Some {} 6 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_no_full_path_names/project/directory/sub.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief Subdirectory file 3 | */ 4 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_code_language/code.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if [ -d '/user' ]; then echo "Hello"; fi 4 | false 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/other-page.dox: -------------------------------------------------------------------------------- 1 | /** @page other-page Other page 2 | 3 | Contents of other subpage. 4 | */ 5 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_feeds_no_url/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2018-09-13 5 | :category: A Category 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_footer_links/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :category: A category 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_modified_date/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-08 5 | :modified: 2017-12-10 6 | -------------------------------------------------------------------------------- /plugins/m/test/alias/articles/article.rst: -------------------------------------------------------------------------------- 1 | An Article 2 | ########## 3 | 4 | :date: 2018-05-06 5 | :alias: /blog/old-article/ 6 | -------------------------------------------------------------------------------- /documentation/test/js-test-data/unicode.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/unicode.bin -------------------------------------------------------------------------------- /documentation/test_python/inspect_create_intersphinx/page.rst: -------------------------------------------------------------------------------- 1 | A documentation page 2 | #################### 3 | 4 | Page content. 5 | -------------------------------------------------------------------------------- /documentation/test_python/page_plugins/dot.rst: -------------------------------------------------------------------------------- 1 | Dot 2 | ### 3 | 4 | .. digraph:: 5 | :class: m-warning 6 | 7 | a -> b -> c 8 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_minimal/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-09 5 | :cover: image.jpg 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_news_on_index/article3.rst: -------------------------------------------------------------------------------- 1 | Article that's not shown 2 | ######################## 3 | 4 | :date: 2014-02-14 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/doxyfile/Doxyfile: -------------------------------------------------------------------------------- 1 | # Includes 2 | @INCLUDE = Doxyfile-another 3 | 4 | # Quotes 5 | PROJECT_BRIEF = "is cool" 6 | -------------------------------------------------------------------------------- /documentation/test_python/link_formatting/page.rst: -------------------------------------------------------------------------------- 1 | This is a page 2 | ############## 3 | 4 | .. image:: tiny.png 5 | :scale: 2000% 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_footer_links/article2.rst: -------------------------------------------------------------------------------- 1 | An article 2 2 | ############ 3 | 4 | :date: 2017-12-09 5 | :category: Another category 6 | -------------------------------------------------------------------------------- /site/.gitattributes: -------------------------------------------------------------------------------- 1 | # Make the GitHub language stats bar prettier 2 | Makefile linguist-generated 3 | develop_server.sh linguist-generated 4 | -------------------------------------------------------------------------------- /doc/examples/tags/jumbo.rst: -------------------------------------------------------------------------------- 1 | Jumbo 2 | ##### 3 | 4 | Detailed tag info provided by the `Metadata <{filename}/plugins/metadata.rst>`_ 5 | plugin. 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_author_list/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-09 5 | :cover: image.jpg 6 | 7 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_draft/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :cover: image.jpg 6 | :status: draft 7 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_heading/File.h: -------------------------------------------------------------------------------- 1 | /// =============== 2 | /// The Thing 3 | /// =============== 4 | namespace Namespace {} 5 | -------------------------------------------------------------------------------- /documentation/test_python/page/error.rst: -------------------------------------------------------------------------------- 1 | This page has a title 2 | ##################### 3 | 4 | But it 5 | also 6 | has 7 | errors. 8 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/stubs_module_dependencies/sub/__init__.py: -------------------------------------------------------------------------------- 1 | class Type: 2 | class InnerClass: 3 | ... 4 | -------------------------------------------------------------------------------- /doc/plugins/math-and-code-snippet.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | int main() { 4 | std::cout << "Hello world!" << std::endl; 5 | return 0; 6 | } 7 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/00-page-order.dox: -------------------------------------------------------------------------------- 1 | /** 2 | 3 | @page 03-first First 4 | @page 01-second Second 5 | @page 02-last Last 6 | 7 | */ 8 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_submodules_package/pybind_submodules_package/__init__.py: -------------------------------------------------------------------------------- 1 | import pybind_submodules_package.sub 2 | 3 | __all__ = ['sub'] 4 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_archived_article/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 1982-01-16 5 | :archived: True 6 | 7 | Article content. 8 | -------------------------------------------------------------------------------- /pelican-theme/test/page_breadcrumb/subpage.rst: -------------------------------------------------------------------------------- 1 | Subpage 2 | ####### 3 | 4 | :breadcrumb: 5 | {index} Index page 6 | {filename}/page.rst A page 7 | -------------------------------------------------------------------------------- /plugins/m/test/alias/even-older-page.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /plugins/m/test/alias/old-page/index.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | charset = utf-8 3 | indent_style = space 4 | indent_size = 4 5 | 6 | [*.{css,html,tag,yml}] 7 | indent_style = space 8 | indent_size = 2 9 | -------------------------------------------------------------------------------- /documentation/test_python/content_html_escape/stubs/content_html_escape/pybind.pyi: -------------------------------------------------------------------------------- 1 | def default_value_should_be_escaped(string: str = '<&>') -> int: 2 | ... 3 | -------------------------------------------------------------------------------- /documentation/.istanbul.yml: -------------------------------------------------------------------------------- 1 | instrumentation: 2 | root: . 3 | extensions: 4 | - .js 5 | default-excludes: true 6 | excludes: ['test_*/**'] 7 | -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns1-ri2-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns1-ri2-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns1-ri2-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns1-ri2-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns1-ri3-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns1-ri3-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns1-ri3-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns1-ri3-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns1-ri4-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns1-ri4-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns1-ri4-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns1-ri4-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns2-ri2-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns2-ri2-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns2-ri2-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns2-ri2-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns2-ri3-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns2-ri3-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns2-ri3-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns2-ri3-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns2-ri4-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns2-ri4-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/manyresults-ns2-ri4-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/manyresults-ns2-ri4-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns1-ri2-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns1-ri2-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns1-ri2-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns1-ri2-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns1-ri3-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns1-ri3-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns1-ri3-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns1-ri3-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns1-ri4-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns1-ri4-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns1-ri4-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns1-ri4-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns2-ri2-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns2-ri2-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns2-ri2-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns2-ri2-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns2-ri3-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns2-ri3-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns2-ri3-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns2-ri3-fo4.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns2-ri4-fo3.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns2-ri4-fo3.bin -------------------------------------------------------------------------------- /documentation/test/js-test-data/searchdata-ns2-ri4-fo4.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mosra/m.css/master/documentation/test/js-test-data/searchdata-ns2-ri4-fo4.bin -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/yet-another-subpage.dox: -------------------------------------------------------------------------------- 1 | /** @page yet-another-subpage Yet another subpage 2 | 3 | Contents of yet another subpage. 4 | */ 5 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_name_mapping/stubs/pybind_name_mapping/submodule.py: -------------------------------------------------------------------------------- 1 | from . import * 2 | 3 | def foo(arg0: Class, arg1: int, /) -> int: 4 | ... 5 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_jumbo_inverted/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-09 5 | :cover: image.jpg 6 | :class: m-inverted 7 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_pagination/article1.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-07 5 | :summary: A summary. 6 | 7 | The content. It's not shown. 8 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Make the GitHub language stats bar prettier 2 | doc/* linguist-documentation 3 | css/*.compiled.css linguist-generated 4 | *.h linguist-language=C++ 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_subpage_of_index/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | - @subpage page 4 | */ 5 | 6 | /** @page page A page 7 | 8 | A page 9 | */ 10 | -------------------------------------------------------------------------------- /documentation/test_python/page/another.rst: -------------------------------------------------------------------------------- 1 | Another page 2 | ############ 3 | 4 | :summary: Here's some summary. **It's formatted as well.** 5 | 6 | And the *text*. 7 | -------------------------------------------------------------------------------- /plugins/m/test/alias/blog/old-article/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_listing/TopLevelFile.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief Top-level file 3 | */ 4 | 5 | /** @brief Top-level class */ 6 | class TopLevelClass {}; 7 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :summary: The summary. 6 | 7 | The content, not expanded. 8 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_global_social_meta/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-16 5 | :category: A category 6 | :tags: A tag 7 | :author: The Author 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_ignored/File.cpp: -------------------------------------------------------------------------------- 1 | /** Undocumented file */ 2 | 3 | /** @brief A var that doesn't appear in the docs because it's in undoc file */ 4 | int a; 5 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_duplicate_class/inspect_duplicate_class/sub.py: -------------------------------------------------------------------------------- 1 | """A submodule.""" 2 | 3 | class Foo: 4 | """A class present in two modules.""" 5 | pass 6 | -------------------------------------------------------------------------------- /pelican-theme/test/page_html_escape/breadcrumb.rst: -------------------------------------------------------------------------------- 1 | Page with <&> in title 2 | ###################### 3 | 4 | :breadcrumb: index.html?and&in&breadcrumb="" And <&> in breadcrumb 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_htmlonly_htmlinclude/file.html: -------------------------------------------------------------------------------- 1 |

This goes from a HTML file and should not be wrapped 2 | twice in <p>.

3 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_name_mapping/stubs/inspect_name_mapping/submodule.py: -------------------------------------------------------------------------------- 1 | from . import * 2 | 3 | def foo(a: Class, b: int) -> yay.ThisGotOverridenExternally: 4 | ... 5 | -------------------------------------------------------------------------------- /pelican-theme/templates/index.html: -------------------------------------------------------------------------------- 1 | {% extends "archives.html" %} 2 | 3 | {% block social_url %} 4 | 5 | {% endblock %} 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_pagination/article2.rst: -------------------------------------------------------------------------------- 1 | Another article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :summary: Another summary. 6 | 7 | The content. It's also not shown. 8 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_archived_article/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 1982-01-16 5 | :cover: image.jpg 6 | :archived: True 7 | 8 | Article content. 9 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_languages/file.c: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A C file, which should stay 3 | */ 4 | 5 | /** @brief A typesafe C function */ 6 | void foo(void** const**, ...); 7 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_name_mapping/stubs/inspect_name_mapping/__init__.py: -------------------------------------------------------------------------------- 1 | class Class: 2 | def a_thing(self) -> Class: 3 | ... 4 | 5 | def foo() -> Class: 6 | ... 7 | -------------------------------------------------------------------------------- /plugins/m/test/abbr/page.rst: -------------------------------------------------------------------------------- 1 | m.abbr 2 | ###### 3 | 4 | .. role:: abbr-strong(abbr) 5 | :class: m-text m-strong 6 | 7 | :abbr:`Text `. :abbr:`Text`. :abbr-strong:`Strong Abbr <STRONGG!>`. 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_xmls/Foxydile.xml: -------------------------------------------------------------------------------- 1 | <!-- this file should get opened but skipped because it doesn't contain a 2 | <doxygen> element --> 3 | <doxyfile> 4 | <option/> 5 | </doxyfile> 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :summary: The summary. 6 | :collapse_first: True 7 | 8 | The content, not expanded. 9 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_name_mapping/stubs/pybind_name_mapping/__init__.py: -------------------------------------------------------------------------------- 1 | class Class: 2 | @staticmethod 3 | def a_thing() -> Class: 4 | ... 5 | 6 | def foo() -> Class: 7 | ... 8 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_custom_header_extension/stubs/stubs_custom_header_extension/sub.custom.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # This is a custom header containing no trailing newline on its own. 4 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_pagination/article3.rst: -------------------------------------------------------------------------------- 1 | Third article 2 | ############# 3 | 4 | :date: 2017-12-09 5 | :summary: Third summary. 6 | 7 | The content. It's shown because it's first on the first page. 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_code_language/snippet.cpp: -------------------------------------------------------------------------------- 1 | /** [0] */ 2 | void foo() { return; } 3 | /** [0] */ 4 | 5 | /** [1] */ 6 | #include <cmath> 7 | 8 | void bar() { return; } 9 | /** [1] */ 10 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_signatures/false_positives.py: -------------------------------------------------------------------------------- 1 | 2 | # This shouldn't be treated as a pybind signature 3 | def reset(): 4 | """resets everything. Shouldn't be picked as a pybind signature.""" 5 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_custom_header_extension/stubs/stubs_custom_header_extension/__init__.custom.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # This is a custom header containing no trailing newline on its own. 4 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :summary: The summary. 6 | :collapse_first: False 7 | 8 | The content, expanded fully on the page. 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global/article2.rst: -------------------------------------------------------------------------------- 1 | An article 2 2 | ############ 3 | 4 | :date: 2017-12-08 5 | :summary: Article 2 summary. 6 | 7 | The content, not expanded as this is a second article. 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_multiline/File.h: -------------------------------------------------------------------------------- 1 | /// First line of a brief output 2 | /// @{ 3 | /// Second line of a brief output gets ignored with a warning 4 | namespace Namespace {} 5 | 6 | /// @} 7 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_string/inspect_string/subpackage/__init__.py: -------------------------------------------------------------------------------- 1 | """A subpackage""" 2 | 3 | class Foo: 4 | """A class in a subpackage. Shouldn't cause the module tree to have an expander for it.""" 5 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/stubs/stubs_module_dependencies/pybind/__init__.py: -------------------------------------------------------------------------------- 1 | import typing 2 | from . import sub 3 | 4 | def function(arg0: sub.Foo, /) -> typing.Callable[[], int]: 5 | ... 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_author_list_tags/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-09 5 | :cover: image.jpg 6 | :tags: All, the, Cool, Tags, Which, Are, Really really really, A Lot 7 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global_hide_summary_global/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :summary: The summary, shown on listing. 6 | 7 | The content, expanded only on page. 8 | -------------------------------------------------------------------------------- /pelican-theme/test/page/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :description: Page description for the fake SEO believers. 5 | :summary: Page description for the social people. 6 | 7 | Page content for those who actually read. 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/example/path-prefix/main.cpp: -------------------------------------------------------------------------------- 1 | #include <iostream> 2 | 3 | #include "configure.h" 4 | 5 | int main() { 6 | #ifdef SAY_HELLO 7 | std::cout << "hello?" << std::endl; 8 | #endif 9 | } 10 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_recursive/inspect_recursive/first.py: -------------------------------------------------------------------------------- 1 | """First module, imported as inspect_recursive.first, with no contents""" 2 | 3 | import inspect_recursive 4 | 5 | from inspect_recursive import Foo as Bar 6 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_enums/docs.rst: -------------------------------------------------------------------------------- 1 | .. py:enum:: pybind_enums.MyEnum 2 | :value First: First value external documentation 3 | :value Second: Second value external documentation 4 | 5 | External details. 6 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/unparsed_module.py: -------------------------------------------------------------------------------- 1 | # This file isn't included in m.css parsing, so its types are unknown, but it's 2 | # still imported as a dependency 3 | 4 | class UnparsedName: 5 | ... 6 | -------------------------------------------------------------------------------- /pelican-theme/test/page_cover/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :cover: {static}/ship.jpg 5 | :header: This is visible on the top and doesn't break the layout. 6 | :footer: This is visible on the bottom. 7 | 8 | Page text. 9 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_xmls/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | 3 | ##! M_THEME_COLOR = 4 | ##! M_FAVICON = 5 | ##! M_LINKS_NAVBAR1 = 6 | ##! M_LINKS_NAVBAR2 = 7 | ##! M_SEARCH_DISABLED = YES 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_in_navbar/input.dox: -------------------------------------------------------------------------------- 1 | /** @page page-in-navbar A page in navbar 2 | 3 | Detailed docs for a page. 4 | */ 5 | 6 | /** @page page-b B page in navbar 7 | 8 | Detailed docs for a page. 9 | */ 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/search/input.dox: -------------------------------------------------------------------------------- 1 | /** 2 | @page page A page 3 | 4 | - @subpage subpage Subpage 5 | */ 6 | 7 | /** 8 | @page subpage Subpage 9 | 10 | Some content. 11 | */ 12 | 13 | /** @example example.cpp */ 14 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes/First.cpp: -------------------------------------------------------------------------------- 1 | /* This is here only to make Doxygen pick First.cpp over First.h and thus make 2 | location of the namespace in First.cpp (which is not wanted) */ 3 | 4 | namespace Contained {} 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/03-first.dox: -------------------------------------------------------------------------------- 1 | /** @page 03-first First 2 | 3 | Contents of first page, with subpages. 4 | 5 | - @subpage other-page 6 | - @subpage yet-another-subpage 7 | - @subpage a-subpage 8 | 9 | */ 10 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article/article2.rst: -------------------------------------------------------------------------------- 1 | An article 2 2 | ############ 3 | 4 | :date: 2017-12-08 5 | :summary: Article 2 summary. 6 | :collapse_first: True 7 | 8 | The content, not expanded as this is a second article. 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both/article2.rst: -------------------------------------------------------------------------------- 1 | An article 2 2 | ############ 3 | 4 | :date: 2017-12-08 5 | :summary: Article 2 summary. 6 | :collapse_first: False 7 | 8 | The content, not expanded as this is a second article. 9 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/authors/author-with-no-image.rst: -------------------------------------------------------------------------------- 1 | Author with no image 2 | #################### 3 | 4 | :badge: Contents of the badge w/o image. 5 | 6 | Contents of author details w/o image, displayed on top of the author page. 7 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_dot/colors.dot: -------------------------------------------------------------------------------- 1 | digraph Colors { 2 | a [class="m-success"] 3 | b [style=filled shape=circle class="m-dim"] 4 | a -> b [class="m-warning" label="yes"] 5 | b -> b [class="m-primary" label="no"] 6 | } 7 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_string/inspect_string/subpackage/inner.py: -------------------------------------------------------------------------------- 1 | """An inner module that's not transitively imported 2 | 3 | But added explicitly via its full path instead, and should be properly inserted 4 | into the hierarchy. 5 | """ 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article_hide_summary_global/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :collapse_first: True 6 | :summary: The summary, shown on listing. 7 | 8 | The content, expanded only on page. 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global_hide_summary_article/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :hide_summary: True 6 | :summary: The summary, shown on listing. 7 | 8 | The content, expanded only on page. 9 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout/index.xml: -------------------------------------------------------------------------------- 1 | <?xml version='1.0' encoding='UTF-8' standalone='no'?> 2 | <doxygenindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="index.xsd" version="1.0.666"> 3 | </doxygenindex> 4 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both_hide_summary_global/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :collapse_first: False 6 | :summary: The summary, shown nowhere. 7 | 8 | The content, expanded on listing and on page. 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_hide_summary_both/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :hide_summary: False 6 | :summary: The summary, repeated on the page. 7 | 8 | The content, expanded fully both in the listing and on the page. 9 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes_templated/Second.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief Second file 3 | */ 4 | 5 | namespace Spread { 6 | 7 | /** @brief A templated variable */ 8 | template<class T> constexpr const T* Var = nullptr; 9 | 10 | } 11 | -------------------------------------------------------------------------------- /pelican-theme/test/page_header_footer/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :header: Page header. With multiple lines. 5 | Linking to `self <{filename}/page.rst>`_. 6 | :footer: Page footer. Linking to `self <{filename}/page.rst>`_. 7 | 8 | Page content. 9 | -------------------------------------------------------------------------------- /plugins/m/test/htmlsanity_typography_global_lang/page.rst: -------------------------------------------------------------------------------- 1 | Hyphenation in other languages 2 | ############################## 3 | 4 | Text všech stránek je česky (``DEFAULT_LANG`` je ``'cs'``) a měl by mít tedy 5 | české dělení slov. "A také české uvozovky." 6 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_section_underscore_one/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | @section section_1 A section 3 | 4 | The section name has `_1` in it, which is the same as the compound/section 5 | separator that Doxygen puts in. It shouldn't assert. 6 | */ 7 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_builtin/docs.rst: -------------------------------------------------------------------------------- 1 | .. py:function:: inspect_builtin.BaseException.__reduce__ 2 | 3 | External docs to trigger the function to be shown in a detailed view as 4 | well to test that the ellipsis gets correctly shown there too. 5 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global_hide_summary_both/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :hide_summary: False 6 | :summary: The summary, expanded only on listing. 7 | 8 | The content, expanded on listing and on page. 9 | -------------------------------------------------------------------------------- /documentation/templates/python/entry-class.html: -------------------------------------------------------------------------------- 1 | <dt>class <a href="{{ class.url }}" class="m-doc">{{ class.name }}</a>{% if class.is_deprecated %} <span class="m-label m-danger">deprecated</span>{% endif %}</dt> 2 | <dd>{{ class.summary }}</dd> 3 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_internal/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | This is a normal text. 4 | 5 | @internal 6 | This is internal docs, which is shown because `INTERNAL_DOCS` are enabled. 7 | @endinternal 8 | 9 | This is public docs again. 10 | */ 11 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_brief/input.dox: -------------------------------------------------------------------------------- 1 | /** @page page-a A page 2 | @brief Brief docs for a page 3 | 4 | Detailed docs for a page. 5 | */ 6 | 7 | /** @page page-b Page B 8 | @brief Brief with a period. 9 | 10 | Detailed docs for page B. 11 | */ 12 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_hide_summary_global/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :summary: The summary, shown in listing but not on the page. 7 | 8 | The content, expanded fully only on the page. 9 | -------------------------------------------------------------------------------- /plugins/m/test/htmlsanity_typography/articles/jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-10 5 | :cover: image.jpg?and&in&url="" 6 | :category: A category 7 | :author: An Author 8 | :tags: Tagging a name 9 | 10 | Article content. 11 | -------------------------------------------------------------------------------- /plugins/m/test/htmlsanity_typography/page-lang.rst: -------------------------------------------------------------------------------- 1 | Page in different language 2 | ########################## 3 | 4 | :lang: cs 5 | 6 | Text této stránky je česky (přičemž ``DEFAULT_LANG`` je ``'en'``) a měl by tedy 7 | mít české dělení slov. "A také české uvozovky." 8 | -------------------------------------------------------------------------------- /plugins/m/test/metadata_typography_html_escape/articles/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-17 5 | :author: An <&> Author 6 | :category: A <&> category 7 | :tags: A <&> tag 8 | :summary: Article summary. 9 | 10 | Article contents. 11 | -------------------------------------------------------------------------------- /documentation/templates/python/entry-module.html: -------------------------------------------------------------------------------- 1 | <dt>module <a href="{{ module.url }}" class="m-doc">{{ module.name }}</a>{% if module.is_deprecated %} <span class="m-label m-danger">deprecated</span>{% endif %}</dt> 2 | <dd>{{ module.summary }}</dd> 3 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_name_mapping/inspect_name_mapping/_sub/__init__.py: -------------------------------------------------------------------------------- 1 | class Foo: 2 | """A class""" 3 | # https://stackoverflow.com/a/33533514, have to use a string in Py3 4 | def a_thing(self) -> 'Foo': 5 | """A method""" 6 | pass 7 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_signatures/stubs/pybind_signatures/just_overloads.pyi: -------------------------------------------------------------------------------- 1 | import typing 2 | 3 | @typing.overload 4 | def overloaded(arg0: int, /) -> str: 5 | ... 6 | 7 | @typing.overload 8 | def overloaded(arg0: float, /) -> bool: 9 | ... 10 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global_hide_summary_global/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :summary: Jumbo article summary, shown only on listing. 7 | 8 | The content, expanded only on page. 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_hide_summary_article/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :hide_summary: True 6 | :summary: The summary, shown neither in listing nor on the page. 7 | 8 | The content, expanded fully both in listing and on the page. 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_hide_summary_global/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :hide_summary: True 6 | :summary: The summary, shown neither in listing nor on the page. 7 | 8 | The content, expanded fully both in listing and on the page. 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_news_on_index/article2.rst: -------------------------------------------------------------------------------- 1 | Article with an especially elongated headline so it blows all the shit up in a totally bad way 2 | ############################################################################################## 3 | 4 | :date: 2018-01-16 5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_template_fallback/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | 3 | ##! M_LINKS_NAVBAR1 = 4 | ##! M_LINKS_NAVBAR2 = 5 | ##! M_PAGE_FINE_PRINT = 6 | ##! M_THEME_COLOR = 7 | ##! M_FAVICON = 8 | ##! M_SEARCH_DISABLED = YES 9 | -------------------------------------------------------------------------------- /documentation/test_python/content/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :ref-prefix: 5 | content 6 | content.EnumWithSummary 7 | :summary: Link to a :ref:`Class` and :ref:`VALUE` from a summary. 8 | 9 | Link to an :ref:`Enum` and :ref:`THIRD` from the content. 10 | -------------------------------------------------------------------------------- /pelican-theme/test/page_landing/hide-navbar-brand-no-cover.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :hide_navbar_brand: True 5 | :landing: 6 | .. container:: m-row 7 | 8 | .. container:: m-col-m-6 m-push-m-3 9 | 10 | Landing text. 11 | 12 | Page text. 13 | -------------------------------------------------------------------------------- /documentation/test_doxygen/example/path-prefix/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | configure_file(${CMAKE_CURRENT_SOURCE_DIR}/configure.h.cmake 2 | ${CMAKE_CURRENT_BINARY_DIR}/configure.h) 3 | 4 | add_executable(app main.cpp) 5 | target_include_directories(app ${CMAKE_CURRENT_BINARY_DIR}) 6 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article_hide_summary_article/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :collapse_first: True 6 | :hide_summary: True 7 | :summary: The summary, shown on listing. 8 | 9 | The content, expanded only on page. 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_hr/File.h: -------------------------------------------------------------------------------- 1 | /// ************** 2 | /// 3 | /// SOME HEAVY LICENSE HEADER WITH SOME HEAVY WORDS 4 | /// 5 | /// ************** 6 | 7 | namespace Namespace { 8 | 9 | /// Some normal brief documentation 10 | void foo(); 11 | 12 | } 13 | -------------------------------------------------------------------------------- /documentation/test_python/content_html_escape/page.rst: -------------------------------------------------------------------------------- 1 | Page title that should be <&> escaped <&>, and also in the page tree 2 | #################################################################### 3 | 4 | Page content that <&> *is* rST-processed <&> and thus gets escaped by docutils. 5 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both_hide_summary_article/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :collapse_first: False 6 | :hide_summary: True 7 | :summary: The summary, shown nowhere. 8 | 9 | The content, expanded on listing and on page. 10 | -------------------------------------------------------------------------------- /pelican-theme/test/page_html_escape/landing.rst: -------------------------------------------------------------------------------- 1 | <&> in site name 2 | ################ 3 | 4 | :cover: image.jpg?and&in&url="" 5 | :landing: 6 | .. container:: m-row 7 | 8 | .. container:: m-col-m-6 m-push-m-3 9 | 10 | Landing text. 11 | 12 | Page text. 13 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_submodules/pybind_submodules.cpp: -------------------------------------------------------------------------------- 1 | #include <pybind11/pybind11.h> 2 | 3 | PYBIND11_MODULE(pybind_submodules, m) { 4 | m.doc() = "pybind11 submodules"; 5 | 6 | m.def_submodule("sub", "Yay a submodule"); 7 | m.def_submodule("another", "Yay another"); 8 | } 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article_hide_summary_both/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :collapse_first: True 6 | :hide_summary: False 7 | :summary: The summary, expanded only on listing. 8 | 9 | The content, expanded on listing and on page. 10 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_submodules_package/sub.cpp: -------------------------------------------------------------------------------- 1 | #include <pybind11/pybind11.h> 2 | 3 | PYBIND11_MODULE(sub, m) { 4 | m.doc() = "pybind11 submodule of a Python package"; 5 | 6 | m.def_submodule("subsub", "Yay a submodule"); 7 | m.def_submodule("another", "Yay another"); 8 | } 9 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_hide_summary_article/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :hide_summary: True 7 | :summary: The summary, shown in listing but not on the page. 8 | 9 | The content, expanded fully only on the page. 10 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_hide_summary_both/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :hide_summary: False 7 | :summary: The summary, shown in both listing and on the page. 8 | 9 | The content, expanded fully only on the page. 10 | -------------------------------------------------------------------------------- /pelican-theme/test/page_landing/hide-navbar-brand.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :cover: {static}/ship.jpg 5 | :hide_navbar_brand: True 6 | :landing: 7 | .. container:: m-row 8 | 9 | .. container:: m-col-m-6 m-push-m-3 10 | 11 | Landing text. 12 | 13 | Page text. 14 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_broken_signatures/pybind_broken_signatures/__init__.py: -------------------------------------------------------------------------------- 1 | from math import log 2 | from .pybind import * 3 | 4 | # log() is like in inspect_builtin, but here testing behavior with the missing 5 | # signatures affecting search data 6 | __all__ = ['log', 'overload', 'overload2'] 7 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_enums/stubs/pybind_enums.pyi: -------------------------------------------------------------------------------- 1 | import enum 2 | 3 | class MyEnum(enum.Enum): 4 | First = 0 5 | Second = 1 6 | Third = 74 7 | CONSISTANTE = -5 8 | 9 | class SixtyfourBitFlag(enum.Enum): 10 | Yes = 1000000000000 11 | No = 18446744073709551615 12 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both_hide_summary_both/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :collapse_first: False 6 | :hide_summary: False 7 | :summary: The summary, expanded on both listing and page. 8 | 9 | The content, expanded on listing and on page. 10 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both_hide_summary_global/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :collapse_first: False 7 | :summary: Jumbo article summary, shown only on listing. 8 | 9 | The content, expanded only on page. 10 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global_hide_summary_article/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :hide_summary: True 7 | :summary: Jumbo article summary, shown only on listing. 8 | 9 | The content, expanded only on page. 10 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_global_hide_summary_both/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :hide_summary: False 7 | :summary: Jumbo article summary, expanded only on listing. 8 | 9 | The content, expanded only on page. 10 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/entry-dir.html: -------------------------------------------------------------------------------- 1 | <dt>directory <a href="{{ dir.url }}" class="m-doc">{{ dir.name }}</a>/{% if dir.deprecated %} <span class="m-label m-danger">{{ dir.deprecated }}</span>{% endif %}{% if dir.since %} {{ dir.since }}{% endif %}</dt> 2 | <dd>{{ dir.brief }}</dd> 3 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_anchor_html_no_prefix_bug/input.dox: -------------------------------------------------------------------------------- 1 | /** @page some-long-page-name A page 2 | 3 | <a name="anchor"></a> 4 | 5 | Here's a HTML anchor for which Doxygen doesn't produce a prefix like for the 6 | normal `@anchor` because it's buggy. But we have to parse it nevertheless! 7 | */ 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_brief_multiline_ingroup/File.h: -------------------------------------------------------------------------------- 1 | /** @defgroup thatgroup This is a group */ 2 | 3 | /** 4 | @brief Function that's in a group 5 | @ingroup thatgroup 6 | 7 | Lines of detailed description that get merged to the brief for no freaking 8 | reason. 9 | */ 10 | void foo(); 11 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article_hide_summary_global/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :collapse_first: True 7 | :summary: Jumbo article summary, shown only on listing. 8 | 9 | The content, expanded only on page. 10 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/entry-file.html: -------------------------------------------------------------------------------- 1 | <dt>file <a href="{{ file.url }}" class="m-doc">{{ file.name }}</a>{% if file.deprecated %} <span class="m-label m-danger">{{ file.deprecated }}</span>{% endif %}{% if file.since %} {{ file.since }}{% endif %}</dt> 2 | <dd>{{ file.brief }}</dd> 3 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_deprecated/deprecated-page.dox: -------------------------------------------------------------------------------- 1 | /** @page deprecated-page Deprecated page 2 | @deprecated This page is deprecated. 3 | 4 | @subpage deprecated-subpage 5 | */ 6 | 7 | /** @page deprecated-subpage Deprecated sub-page 8 | @deprecated This page is *also* deprecated. 9 | */ 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_search_binary/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | 3 | ##! M_PAGE_FINE_PRINT = 4 | ##! M_THEME_COLOR = 5 | ##! M_FAVICON = 6 | ##! M_LINKS_NAVBAR1 = 7 | ##! M_LINKS_NAVBAR2 = 8 | ##! M_SEARCH_DOWNLOAD_BINARY = YES 9 | ##! M_SEARCH_HELP = "Halp." 10 | -------------------------------------------------------------------------------- /pelican-theme/test/page_html_escape/page.rst: -------------------------------------------------------------------------------- 1 | Page with <&> in title 2 | ###################### 3 | 4 | :url: page.html?and&overriden&url="" 5 | :description: And <&> in description. 6 | :summary: And <&> in summary. 7 | :header: And <&> in header. 8 | :footer: And <&> in footer. 9 | 10 | And <&> in content. 11 | -------------------------------------------------------------------------------- /plugins/m/test/link/page.rst: -------------------------------------------------------------------------------- 1 | m.link 2 | ###### 3 | 4 | .. role:: link-flat(link) 5 | :class: m-flat m-text m-strong 6 | 7 | - URL with no title: :link:`https://mcss.mosra.cz` 8 | - URL with a title: :link:`m.css <https://mcss.mosra.cz>` 9 | - Link with a class: :link-flat:`https://twitter.com/czmosra` 10 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/articles/article-no-image.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-17 5 | :author: Author with no image 6 | :category: Category with no image 7 | :summary: Article summary. 8 | 9 | This article should have no images anywhere and everything still needs to look 10 | properly. 11 | -------------------------------------------------------------------------------- /plugins/m/test/metadata_typography_html_escape/tags/a-tag.rst: -------------------------------------------------------------------------------- 1 | A <&> "tag" 2 | ########### 3 | 4 | :description: Tag <&> description, not hyphenated but "quotes" 5 | :summary: Tag <&> summary, not hyphenated but "quotes" 6 | :badge: Tag <&> badge, hyphenated and "quotes". 7 | 8 | Tag <&> details, hyphenated and "quotes". 9 | -------------------------------------------------------------------------------- /documentation/.gitignore: -------------------------------------------------------------------------------- 1 | test_doxygen/*/html/ 2 | test_doxygen/*/xml/ 3 | test_doxygen/layout_generated_doxyfile/Doxyfile 4 | !test_doxygen/layout_generated_doxyfile/xml/ 5 | node_modules/ 6 | package-lock.json 7 | test_doxygen/package-lock.json 8 | test_python/*/output/ 9 | test_python/build* 10 | test_python/**/*.so 11 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_blockquote/File.h: -------------------------------------------------------------------------------- 1 | /// @file 2 | /// A file 3 | 4 | ///> An enum on the right 5 | enum Enum { 6 | Value ///< A value on the right 7 | }; 8 | 9 | /* ... where > actually isn't interpreted as "documentation for what follows" 10 | but rather a Markdown blockquote */ 11 | -------------------------------------------------------------------------------- /pelican-theme/test/page_extra_html_head/page.rst: -------------------------------------------------------------------------------- 1 | A page 2 | ###### 3 | 4 | :css: 5 | static/m-debug.css 6 | static/m-grid.css 7 | :js: 8 | a.js 9 | b.js 10 | :html_header: 11 | <!-- this goes into the HTML head 12 | \ another line --> 13 | <!-- have to indent them with a backslash --> 14 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/entry-module.html: -------------------------------------------------------------------------------- 1 | <dt>module <a href="{{ module.url }}" class="m-doc">{{ module.name }}</a>{% if module.deprecated %} <span class="m-label m-danger">{{ module.deprecated }}</span>{% endif %}{% if module.since %} {{ module.since }}{% endif %}</dt> 2 | <dd>{{ module.brief }}</dd> 3 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both_hide_summary_article/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :collapse_first: False 7 | :hide_summary: True 8 | :summary: Jumbo article summary, shown only on listing. 9 | 10 | The content, expanded only on page. 11 | -------------------------------------------------------------------------------- /documentation/test/js-test-data/.gitattributes: -------------------------------------------------------------------------------- 1 | # You have to add the following to your .git/config or global 2 | # ~/.gitconfig to make the binary diffs work (without the comment 3 | # character, of course): 4 | # 5 | # [diff "hex"] 6 | # textconv = hexdump -v -C 7 | # binary = true 8 | # 9 | 10 | *.bin binary diff=hex 11 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article_hide_summary_article/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :collapse_first: True 7 | :hide_summary: True 8 | :summary: Jumbo article summary, shown only on listing. 9 | 10 | The content, expanded only on page. 11 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_html_escape/article.rst: -------------------------------------------------------------------------------- 1 | Article with <&> in title 2 | ######################### 3 | 4 | :date: 2017-12-09 5 | :author: And <&> in author 6 | :description: And <&> in description. 7 | :tags: And <&> in tag 8 | :category: And <&> in category 9 | :summary: And <&> in summary. 10 | 11 | And <&> in content. 12 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/articles/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-17 5 | :author: An Author 6 | :category: A category 7 | :tags: A tag 8 | :summary: Article summary. 9 | 10 | There should be a category image + author's twitter in the social meta tag and 11 | two badges with images on the bottom. 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_code_filters/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | Adding typographically correct spaces before and a color swatch after --- and 4 | for inline as well: @code{.css} p{ color:#ff3366; } @endcode 5 | 6 | @code{.css} 7 | 8 | p{ 9 | color:#ff3366; 10 | } 11 | 12 | @endcode 13 | 14 | */ 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_tagfile/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | See @ref CORRADE_ASSERT() for more information. The snippet below should have a 4 | link in the XML but not in the generated HTML (verifying it's correctly 5 | stripped). 6 | 7 | @code{.cpp} 8 | Corrade::Containers::String s; 9 | @endcode 10 | 11 | */ 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_xmls/thingsgotcrazy.xml: -------------------------------------------------------------------------------- 1 | <!-- this file should get opened but skipped because it doesn't contain a 2 | <compounddef> as the first thing in the <doxygen> element. Might be a bit 3 | too tight, but better safe than sorry AGAIN. --> 4 | <doxygen> 5 | <crazyisay/> 6 | <compounddef/> 7 | </doxygen> 8 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_article_hide_summary_both/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :collapse_first: True 7 | :hide_summary: False 8 | :summary: Jumbo article summary, expanded only on listing. 9 | 10 | The content, expanded only on page. 11 | 12 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_collapse_first_both_hide_summary_both/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-08 5 | :cover: image.jpg 6 | :collapse_first: False 7 | :hide_summary: False 8 | :summary: Jumbo article summary, expanded on both listing and page. 9 | 10 | The content, expanded only on page. 11 | -------------------------------------------------------------------------------- /plugins/m/test/math_cached/page.rst: -------------------------------------------------------------------------------- 1 | Math 2 | #### 3 | 4 | In order to actually test use of the cache, I need to cheat a bit. Inline 5 | formula which is pi in the source but :math:`\pi` here. Then a block 6 | formula which is a Pythagorean theorem in source but not in the output: 7 | 8 | .. math:: 9 | 10 | a^2 + b^2 = c^2 11 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/articles/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | A jumbo article 2 | ############### 3 | 4 | :date: 2017-12-16 5 | :cover: image.jpg 6 | :author: An Author 7 | :category: A category 8 | :summary: Article summary. 9 | 10 | An article that should have its own cover image in social meta tags, not the 11 | category-specific one. 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_footer_navigation/input.dox: -------------------------------------------------------------------------------- 1 | /** @page page A page 2 | - @subpage subpage1 First subpage 3 | - @subpage subpage2 Second subpage 4 | 5 | */ 6 | 7 | /** @page subpage1 First subpage 8 | 9 | @m_footernavigation 10 | */ 11 | 12 | /** @page subpage2 Second subpage 13 | 14 | @m_footernavigation 15 | */ 16 | 17 | -------------------------------------------------------------------------------- /doc/examples/authors/an-author.rst: -------------------------------------------------------------------------------- 1 | An Author 2 | ######### 3 | 4 | :image: {static}/static/mosra.jpg 5 | :badge: Info badge for `An Author <{author}an-author>`_ provided by the 6 | `Metadata <{filename}/plugins/metadata.rst>`_ plugin. 7 | 8 | Detailed author info provided by the `Metadata <{filename}/plugins/metadata.rst>`_ 9 | plugin. 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_exception_reference/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | 5 | /** @brief An exception */ 6 | struct MyException {}; 7 | 8 | /** 9 | @brief A function that throws 10 | @throw std::runtime_exception This one doesn't have a reference 11 | @throw MyException This one does 12 | */ 13 | void foo(); 14 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/articles/article-minimal.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-17 5 | :author: Minimal author 6 | :category: Minimal category 7 | :tags: Minimal tag 8 | :summary: Article summary. 9 | 10 | There should be no category or author-related anything in the meta tags. Just 11 | badges with default titles. 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_filename_case/input.h: -------------------------------------------------------------------------------- 1 | /** @page page A page 2 | 3 | - @subpage UPPERCASE 4 | - @ref UPPERCLASS 5 | */ 6 | 7 | /** @page UPPERCASE Uppercase page 8 | 9 | This should get saved to a correct place and also get correctly linked to. 10 | */ 11 | 12 | /** @brief An uppercase class */ 13 | class UPPERCLASS {}; 14 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_main_project_url/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | PROJECT_NAME = "Your Brand" 3 | PROJECT_BRIEF = docs 4 | 5 | ##! M_PAGE_FINE_PRINT = 6 | ##! M_THEME_COLOR = 7 | ##! M_FAVICON = 8 | ##! M_SEARCH_DISABLED = YES 9 | ##! M_MAIN_PROJECT_URL = http://your.brand 10 | -------------------------------------------------------------------------------- /plugins/m/test/math_uncached/page.rst: -------------------------------------------------------------------------------- 1 | Math 2 | #### 3 | 4 | In order to actually test use of the cache, I need to cheat a bit. Inline 5 | formula which is pi in the source but :math:`\frac{\tau}{2}` here. Then a block 6 | formula which is a Pythagorean theorem in source but not in the output: 7 | 8 | .. math:: 9 | 10 | a^3 + b^3 \neq c^3 11 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_toc/input.dox: -------------------------------------------------------------------------------- 1 | /** @page page-toc Page with TOC 2 | 3 | @tableofcontents 4 | 5 | @section section A section 6 | 7 | Text. 8 | 9 | @subsection sub-section Subsection 10 | 11 | @subsection sub-section2 Subsection 2 12 | 13 | @subsubsection sub-section3 Subsection 3 14 | 15 | @section section2 Section 2 16 | 17 | */ 18 | -------------------------------------------------------------------------------- /doc/examples/categories/examples.rst: -------------------------------------------------------------------------------- 1 | Examples 2 | ######## 3 | 4 | :image: {static}/static/site.jpg 5 | :badge: Info badge for the `Examples <{category}examples>`_ category provided 6 | by the `Metadata <{filename}/plugins/metadata.rst>`_ plugin. 7 | 8 | Detailed category info provided by the `Metadata <{filename}/plugins/metadata.rst>`_ 9 | plugin. 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes_strip_from_path/project/examples/example.cpp: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief An example file 3 | * 4 | * The file tree should list this file in the root, w/o `project/examples/`. 5 | */ 6 | 7 | #include <Library/Data.h> 8 | #include <Library/Library.h> 9 | 10 | /** @brief An example function */ 11 | int main() {} 12 | -------------------------------------------------------------------------------- /pelican-theme/test/blog/article.rst: -------------------------------------------------------------------------------- 1 | An article 2 | ########## 3 | 4 | :date: 2017-12-09 5 | :category: A category 6 | :tags: First, Third, Second 7 | :author: Explicit Author 8 | :description: Article description for the fake SEO believers. 9 | :summary: The summary. 10 | On multiple 11 | lines. 12 | 13 | The content, expanded fully on the page. 14 | -------------------------------------------------------------------------------- /artwork/README.rst: -------------------------------------------------------------------------------- 1 | Artwork HOWTO 2 | ############# 3 | 4 | favicon.svg 5 | =========== 6 | 7 | Export as 16x16 PNG and convert to an ``*.ico``: 8 | 9 | .. code:: sh 10 | 11 | convert favicon.png favicon.ico 12 | 13 | magnifier.svg 14 | ============= 15 | 16 | Doxygen search icon. Export as "Optimized SVG" and copy into the ``base.html`` 17 | template. 18 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_project_logo/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | PROJECT_NAME = "Your Brand" 3 | PROJECT_LOGO = mosra.jpg 4 | 5 | ##! M_PAGE_FINE_PRINT = 6 | ##! M_THEME_COLOR = 7 | ##! M_FAVICON = 8 | ##! M_LINKS_NAVBAR1 = 9 | ##! M_LINKS_NAVBAR2 = 10 | ##! M_SEARCH_DISABLED = YES 11 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_builtin/inspect_builtin.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from math import log, pow 3 | 4 | from builtins import BaseException 5 | 6 | __all__ = ['pow', 'log', 'BaseException'] 7 | 8 | # Signature with / for pow() is not present in 3.6 so it makes no sense to have 9 | # it there. 10 | if sys.version_info < (3, 7): 11 | __all__ = __all__[1:] 12 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/tags/a-tag.rst: -------------------------------------------------------------------------------- 1 | Tag name, displayed on top of the tag page 2 | ########################################## 3 | 4 | :description: Tag description, used for a <meta name="description"> tag. 5 | :summary: Tag summary, used for the social <meta> tags. 6 | 7 | Contents of tag details, displayed on top of the tag page. 8 | `Link. <https://mcss.mosra.cz>`_ 9 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_name_mapping/inspect_name_mapping/_sub/bar.py: -------------------------------------------------------------------------------- 1 | """This submodule is renamed from bar to submodule and should have a function member.""" 2 | 3 | from . import Foo 4 | 5 | class _NameThatGetsOverridenExternally: 6 | pass 7 | 8 | def foo(a: Foo, b: int) -> _NameThatGetsOverridenExternally: 9 | """A function""" 10 | return b*2 11 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_page/input.h: -------------------------------------------------------------------------------- 1 | /** @defgroup bla A module 2 | @brief Short module description 3 | 4 | @{ */ 5 | 6 | /** @brief A namespace */ 7 | namespace Foo { 8 | 9 | /** @brief A class */ 10 | class Bar {}; 11 | 12 | } 13 | 14 | /* Since 1.8.17, the original short-hand group closing doesn't work anymore. 15 | FFS. */ 16 | /** 17 | * @} 18 | */ 19 | -------------------------------------------------------------------------------- /pelican-theme/test/page_html_escape/content.rst: -------------------------------------------------------------------------------- 1 | Escaping in content 2 | ################### 3 | 4 | - `Self link <{filename}/page.rst>`_ (overriden URL) 5 | - `Self link with more params added <{filename}/page.rst#so=this&works="bad">`_ 6 | - `Link to other page <{filename}/landing.rst>`_ (it doesn't have URL overriden) 7 | - `Link outside <https://a.site/?and&in&url="">`_. 8 | -------------------------------------------------------------------------------- /plugins/m/test/code/ansi.rst: -------------------------------------------------------------------------------- 1 | m.code colored terminal output 2 | ############################## 3 | 4 | .. role:: ansi(code) 5 | :language: ansi 6 | 7 | Trivial console output, including :ansi:`inline` code: 8 | 9 | .. include:: console.ansi 10 | :code: ansi 11 | 12 | All possible console colors: 13 | 14 | .. include:: console-colors.ansi 15 | :code: ansi 16 | -------------------------------------------------------------------------------- /plugins/m/test/htmlsanity_typography/articles/lang.rst: -------------------------------------------------------------------------------- 1 | Article in different language 2 | ############################# 3 | 4 | :date: 2017-12-10 5 | :category: A category 6 | :author: An Author 7 | :tags: Tagging a name 8 | :lang: cs 9 | 10 | Text tohoto článku je česky (přičemž ``DEFAULT_LANG`` je ``'en'``) a měl by 11 | tedy mít české dělení slov. "A také české uvozovky." 12 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_duplicate_class/inspect_duplicate_class/__init__.py: -------------------------------------------------------------------------------- 1 | import enum 2 | from .sub import Foo as Bar 3 | 4 | class AnEnum(enum.Enum): 5 | """An enum which is earlier than Bar, and with values that shouldn't be 6 | checked for duplicates because they don't have the .object property""" 7 | AAA = 3 8 | 9 | __all__ = ['AnEnum', 'sub', 'Bar'] 10 | -------------------------------------------------------------------------------- /plugins/m/test/metadata_typography_html_escape/authors/an-author.rst: -------------------------------------------------------------------------------- 1 | An <&> "Author" 2 | ############### 3 | 4 | :image: author.jpg?and&in&url="" 5 | :description: Author <&> description, not hyphenated but "quotes" 6 | :summary: Author <&> summary, not hyphenated but "quotes" 7 | :badge: Author <&> badge, hyphenated and "quotes". 8 | 9 | Author <&> details, hyphenated and "quotes". 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_inline_namespace/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | 5 | /** @brief A namespace */ 6 | namespace Foo { 7 | 8 | /** @brief An inline nested namespace */ 9 | inline namespace Bar { 10 | 11 | /** @brief Another inline namespace */ 12 | inline namespace Baz {} 13 | 14 | } 15 | 16 | /** @brief A thing */ 17 | struct Thing {}; 18 | 19 | } 20 | -------------------------------------------------------------------------------- /pelican-theme/test/blog_html_escape/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | Article with <&> — a <&> jumbo one 2 | ################################## 3 | 4 | :date: 2017-12-10 5 | :cover: image.jpg?and&in&url="" 6 | :author: And <&> in author 7 | :description: And <&> in description. 8 | :tags: And <&> in tag 9 | :category: And <&> in category 10 | :summary: And <&> in summary. 11 | 12 | And <&> in content. 13 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_type_links/inspect_type_links/__init__.py: -------------------------------------------------------------------------------- 1 | from . import first, second 2 | 3 | class Foo: 4 | """A class in the root module""" 5 | 6 | @property 7 | def prop(self): 8 | """Here just to test the raise option""" 9 | 10 | class Bar: 11 | """Another class in the root module""" 12 | 13 | def open(): 14 | """A function that opens cans.""" 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_no_full_path_names/project/root.h: -------------------------------------------------------------------------------- 1 | /* Sources for the test in ../compound_no_full_path_names, needs to be in a 2 | directory outside of the Doxyfile to trigger the behavior */ 3 | 4 | /** @dir project 5 | * @brief Root directory 6 | */ 7 | 8 | /** @dir project/directory 9 | * @brief Subdirectory 10 | */ 11 | 12 | /** @file 13 | * @brief Root file 14 | */ 15 | -------------------------------------------------------------------------------- /plugins/m/test/metadata_typography_html_escape/categories/a-category.rst: -------------------------------------------------------------------------------- 1 | A <&> "category" 2 | ################ 3 | 4 | :image: category.jpg?and&in&url="" 5 | :description: Category <&> description, not hyphenated but "quotes" 6 | :summary: Category <&> summary, not hyphenated but "quotes" 7 | :badge: Category <&> badge, hyphenated and "quotes". 8 | 9 | Category <&> details, hyphenated and "quotes". 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_single_column/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | 3 | ##! M_LINKS_NAVBAR1 = pages \ 4 | ##! namespaces \ 5 | ##! annotated \ 6 | ##! files 7 | ##! M_LINKS_NAVBAR2 = 8 | ##! M_PAGE_FINE_PRINT = 9 | ##! M_THEME_COLOR = 10 | ##! M_FAVICON = 11 | ##! M_SEARCH_DISABLED = YES 12 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/unparsed_enum_module.py: -------------------------------------------------------------------------------- 1 | # This file isn't included in m.css parsing, so its types are unknown, but it's 2 | # still imported as a dependency and the type is correctly recognized as an 3 | # enum type 4 | 5 | import enum 6 | 7 | class UnparsedEnumClass(enum.Enum): 8 | ... 9 | 10 | class UnparsedEnumSubclass(enum.Enum): 11 | UNPARSED_VALUE = 1337 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_search_opensearch/Doxyfile: -------------------------------------------------------------------------------- 1 | PROJECT_NAME = "A project" 2 | PROJECT_BRIEF = "is cool" 3 | XML_OUTPUT = 4 | 5 | ##! M_PAGE_FINE_PRINT = 6 | ##! M_THEME_COLOR = 7 | ##! M_LINKS_NAVBAR1 = 8 | ##! M_LINKS_NAVBAR2 = 9 | ##! M_SEARCH_BASE_URL = http://localhost:8000 10 | ##! M_SEARCH_HELP = "Right-click to add a search engine." 11 | -------------------------------------------------------------------------------- /documentation/test_python/content_html_escape/content_html_escape/pybind.cpp: -------------------------------------------------------------------------------- 1 | #include <pybind11/pybind11.h> 2 | 3 | namespace py = pybind11; 4 | 5 | int defaultValueShouldBeEscaped(const char*) { return 0; } 6 | 7 | PYBIND11_MODULE(pybind, m) { 8 | m.doc() = "pybind11 html escaping"; 9 | 10 | m.def("default_value_should_be_escaped", defaultValueShouldBeEscaped, py::arg("string") = "<&>"); 11 | } 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_cpp_comments/File.h: -------------------------------------------------------------------------------- 1 | /// @file 2 | /// A file 3 | 4 | /// A typedef 5 | typedef int Typedef; 6 | 7 | //! An enum 8 | enum Enum { 9 | Value, //!< A brief description 10 | Another, /**< A detailed description */ 11 | 12 | /** 13 | * @brief A brief description 14 | * 15 | * And a detailed one as well. 16 | */ 17 | Last 18 | }; 19 | -------------------------------------------------------------------------------- /pelican-theme/test/blog/article-jumbo.rst: -------------------------------------------------------------------------------- 1 | An article — a jumbo one 2 | ######################## 3 | 4 | .. author is implicit 5 | .. em-dash needs to be explicit as smart quotes are not enabled by default 6 | 7 | :date: 2017-12-08 8 | :category: Another category 9 | :tags: Fourth, First, Third 10 | :cover: {static}/ship.jpg 11 | :summary: A summary. 12 | On multiple 13 | lines. 14 | 15 | Some content. 16 | -------------------------------------------------------------------------------- /plugins/m/test/filesize/page.rst: -------------------------------------------------------------------------------- 1 | m.filesize 2 | ########## 3 | 4 | .. role:: filesize-nay(filesize) 5 | :class: m-text m-danger 6 | .. role:: filesize-yay(filesize-gz) 7 | :class: m-text m-success 8 | 9 | This file has :filesize:`{filename}/page.rst` and :filesize-gz:`{filename}/page.rst` 10 | gzipped. I mean, :filesize-yay:`{filename}/page.rst` is good, but 11 | :filesize-nay:`{filename}/page.rst` not. 12 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/categories/category-with-no-image.rst: -------------------------------------------------------------------------------- 1 | Category with no image 2 | ###################### 3 | 4 | :description: Category description, used for a <meta name="description"> tag. 5 | :summary: Category summary, used for the social <meta> tags. 6 | :badge: Contents of the badge w/o image, displayed at article bottom. 7 | 8 | Contents of category details w/o image, displayed on top of the category page. 9 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_ignored/File.h: -------------------------------------------------------------------------------- 1 | namespace { 2 | 3 | /** @brief Struct in an anonymous namespace */ 4 | struct PrivateStruct { int a; /**< A var */ }; 5 | 6 | } 7 | 8 | /** @brief A class */ 9 | class A { 10 | private: 11 | /** @brief Private class */ 12 | class PrivateClass { int a; /**< A var */ }; 13 | }; 14 | 15 | /** @brief A class with just brief docs */ 16 | class Brief {}; 17 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_listing/Doxyfile-strip-from-path: -------------------------------------------------------------------------------- 1 | @INCLUDE = Doxyfile 2 | 3 | # Without this, Doxygen strips all directories from <includes> elements, losing 4 | # the actual filesystem hierarchy. M.css detects that and uses <location> 5 | # instead. This then verifies that the output is the same with 6 | # STRIP_FROM_INC_PATH not set at all and set to a trivial value. 7 | STRIP_FROM_INC_PATH = . 8 | -------------------------------------------------------------------------------- /plugins/m/test/vk/page.rst: -------------------------------------------------------------------------------- 1 | m.vk 2 | #### 3 | 4 | .. role:: vkfn-flat(vkfn) 5 | :class: m-flat 6 | 7 | - Function link: :vkfn:`CreateInstance` 8 | - Type link: :vktype:`InstanceCreateInfo` 9 | - Definition link: :vktype:`VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO <StructureType>` 10 | - Extension link: :vkext:`KHR_swapchain` 11 | - :vkfn:`Custom link title <DestroyInstance>` 12 | - Flat link :vkfn-flat:`DestroyDevice` 13 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_base_template_classes/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | 5 | /** @brief A namespace */ 6 | namespace Namespace { 7 | 8 | /** @brief A base */ 9 | template<class> struct Base {}; 10 | 11 | /** 12 | @brief A class with two different template bases 13 | 14 | The @ref Namespace gets stripped from the references. 15 | */ 16 | struct MyClass: Base<int>, Base<Base<float>> {}; 17 | 18 | } 19 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_name_mapping/pybind_name_mapping/__init__.py: -------------------------------------------------------------------------------- 1 | from ._sub import Foo as Class 2 | from ._sub import bar as submodule 3 | 4 | # This test is almost the same as inspect_name_mapping, only natively 5 | 6 | """This module should have a bar submodule and a Foo class""" 7 | 8 | __all__ = ['submodule', 'Class', 'foo'] 9 | 10 | def foo() -> Class: 11 | """This function returns Class, *not* _sub.Foo""" 12 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/entry-namespace.html: -------------------------------------------------------------------------------- 1 | <dt>namespace <a href="{{ namespace.url }}" class="m-doc">{{ namespace.name }}</a>{% if namespace.is_inline %} <span class="m-label m-flat m-info">inline</span>{% endif %}{% if namespace.deprecated %} <span class="m-label m-danger">{{ namespace.deprecated }}</span>{% endif %}{% if namespace.since %} {{ namespace.since }}{% endif %}</dt> 2 | <dd>{{ namespace.brief }}</dd> 3 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_name_mapping/inspect_name_mapping/__init__.py: -------------------------------------------------------------------------------- 1 | from ._sub import Foo as Class 2 | from ._sub import bar as submodule 3 | 4 | # This test is almost the same as pybind_name_mapping, only pure Python 5 | 6 | """This module should have a `submodule`, a `Class` and `foo()`""" 7 | 8 | __all__ = ['submodule', 'Class', 'foo'] 9 | 10 | def foo() -> Class: 11 | """This function returns Class, *not* _sub.Foo""" 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_blocks/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | 5 | /** 6 | @brief A foo 7 | 8 | @xrefitem old "Old stuff" "Just old" Xrefitem, gets merged 9 | @xrefitem old "Old stuff" "Just old" with this one by Doxygen itself. 10 | 11 | @see See something 12 | @return Does not return anything. 13 | 14 | Text. 15 | 16 | > A quote that should not cause assertion about an unclosed section 17 | */ 18 | int foo(); 19 | -------------------------------------------------------------------------------- /documentation/test_python/page_plugins/plots.rst: -------------------------------------------------------------------------------- 1 | And now something totally different 2 | ################################### 3 | 4 | .. raw:: html 5 | 6 | <style> 7 | div.m-plot svg { font-family: DejaVu Sans; } 8 | </style> 9 | 10 | .. plot:: A plot with a single color 11 | :type: barh 12 | :labels: 13 | First 14 | Second 15 | :units: meters, i guess? 16 | :values: 15 30 17 | :colors: success 18 | -------------------------------------------------------------------------------- /plugins/m/test/gl/page.rst: -------------------------------------------------------------------------------- 1 | m.gl 2 | #### 3 | 4 | .. role:: glfn-flat(glfn) 5 | :class: m-flat 6 | 7 | - Function link: :glfn:`DispatchCompute` 8 | - Extension link: :glext:`ARB_direct_state_access` 9 | - WebGL extension link: :webglext:`OES_texture_float` 10 | - Extension function link: :glfnext:`SpecializeShader <ARB_gl_spirv>` 11 | - :glfn:`Custom link title <DrawElementsIndirect>` 12 | - Flat link: :glfn-flat:`DrawElements` 13 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_project_logo_main_project_url/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | PROJECT_NAME = "Your Brand" 3 | PROJECT_LOGO = mosra.jpg 4 | PROJECT_BRIEF = docs 5 | 6 | ##! M_PAGE_FINE_PRINT = 7 | ##! M_THEME_COLOR = 8 | ##! M_FAVICON = 9 | ##! M_LINKS_NAVBAR1 = 10 | ##! M_LINKS_NAVBAR2 = 11 | ##! M_SEARCH_DISABLED = YES 12 | ##! M_MAIN_PROJECT_URL = http://your.brand 13 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_anchor_in_both_group_and_namespace/File.h: -------------------------------------------------------------------------------- 1 | /** @defgroup fizzbuzz A group 2 | @{ */ 3 | 4 | /* Since 1.8.17, the original short-hand group closing doesn't work anymore. 5 | FFS. */ 6 | /** 7 | * @} 8 | */ 9 | 10 | /** @brief Foo */ 11 | namespace Foo { 12 | 13 | /** 14 | @brief Bar 15 | 16 | @ingroup fizzbuzz 17 | 18 | @anchor this_anchor 19 | 20 | @link this_anchor More details @endlink 21 | */ 22 | void bar(); 23 | 24 | } 25 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_math_code_fallback/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | Here's a block formula: 4 | 5 | @f[ 6 | \hat q = [\boldsymbol 0, 1] + \epsilon [\frac{\boldsymbol v}{2}, 0] 7 | @f] 8 | 9 | And @f$ \hat q @f$ is how quaternion is denoted. A green formula should have 10 | the CSS class applied: 11 | 12 | @m_class{m-success} 13 | 14 | @f[ 15 | \pi^2 16 | @f] 17 | 18 | A yellow @m_class{m-warning} @f$ \Sigma @f$ inline formula as well. 19 | */ 20 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_search_opensearch/opensearch.xml.html: -------------------------------------------------------------------------------- 1 | <?xml version="1.0" encoding="UTF-8"?> 2 | <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"> 3 | <ShortName>A project is cool</ShortName> 4 | <Description>Search A project documentation</Description> 5 | <Image type="image/png">http://localhost:8000/favicon-dark.png</Image> 6 | <Url type="text/html" template="http://localhost:8000?q={searchTerms}#search"/> 7 | </OpenSearchDescription> 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_brief/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_toc/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_recursive/inspect_recursive/second.py: -------------------------------------------------------------------------------- 1 | """Second module, imported as inspect_recursive.a, with no contents""" 2 | 3 | import inspect_recursive.first as a 4 | 5 | import sys 6 | 7 | if sys.version_info >= (3, 7): 8 | # For some reason 3.6 says second doesn't exist yet. I get that, it's a 9 | # cyclic reference, but that works in 3.7. 10 | import inspect_recursive.second as b 11 | 12 | from inspect_recursive import Foo as Bar 13 | -------------------------------------------------------------------------------- /documentation/test_python/layout_search_open_search/opensearch.xml: -------------------------------------------------------------------------------- 1 | <?xml version="1.0" encoding="UTF-8"?> 2 | <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"> 3 | <ShortName>My Python Project</ShortName> 4 | <Description>Search My Python Project documentation</Description> 5 | <Image type="image/png">http://localhost:8000/favicon-dark.png</Image> 6 | <Url type="text/html" template="http://localhost:8000?q={searchTerms}#search"/> 7 | </OpenSearchDescription> 8 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/stubs_module_dependencies/pybind.cpp: -------------------------------------------------------------------------------- 1 | #include <pybind11/pybind11.h> 2 | #include <pybind11/functional.h> 3 | 4 | namespace py = pybind11; 5 | 6 | namespace { 7 | 8 | struct Foo {}; 9 | 10 | std::function<int()> function(const Foo&) { return []{ return 3; }; } 11 | 12 | } 13 | 14 | PYBIND11_MODULE(pybind, m) { 15 | py::class_<Foo>{m.def_submodule("sub"), "Foo"}; 16 | 17 | m.def("function", &function); 18 | } 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_title/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_ignored/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h File.cpp 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_modules/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = modules 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_blockquote/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_blocks/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_code_filters/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_htmlonly_htmlinclude/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | @htmlinclude file.html 4 | */ 5 | 6 | /** @page html-only The htmlonly command 7 | 8 | Works only since Doxygen 1.8.18, before it was not included in the XML output. 9 | 10 | @htmlonly 11 | <iframe style="width: 500px; height: 500px;" src="https://mcss.mosra.cz"> 12 | @endhtmlonly 13 | */ 14 | 15 | /** @page warnings This will produce a warning 16 | 17 | @htmlinclude nonexistent.html 18 | */ 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_typography/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_subpage_of_index/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /css/postprocess.sh: -------------------------------------------------------------------------------- 1 | ./postprocess.py m-dark.css 2 | ./postprocess.py m-dark.css m-documentation.css -o m-dark+documentation.compiled.css 3 | ./postprocess.py m-dark.css m-theme-dark.css m-documentation.css --no-import -o m-dark.documentation.compiled.css 4 | 5 | ./postprocess.py m-light.css 6 | ./postprocess.py m-light.css m-documentation.css -o m-light+documentation.compiled.css 7 | ./postprocess.py m-light.css m-theme-light.css m-documentation.css --no-import -o m-light.documentation.compiled.css 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_base_template_classes/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_crazy_template_params/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_exception_reference/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_unexpected_sections/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/search_long_suffix_length/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DOWNLOAD_BINARY = YES 15 | -------------------------------------------------------------------------------- /documentation/templates/python/entry-data.html: -------------------------------------------------------------------------------- 1 | <dt{% if not data.has_details %} id="{{ data.id }}"{% endif %}> 2 | <a href="#{{ data.id }}" class="m-doc{% if not data.has_details %}-self{% endif %}">{{ data.name }}</a>{% if data.type_link %}: {{ data.type_link }}{% endif %}{% if data.value_link %} = {{ data.value_link }}{% endif %} 3 | {# This has to be here to avoid the newline being eaten #} 4 | 5 | </dt> 6 | <dd>{{ data.summary }}</dd> 7 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_brief_multiline_ingroup/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_section_underscore_one/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes_templated/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = First.h Second.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_order/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = 2 | FILE_PATTERNS = *.dox 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /plugins/m/test/qr/page.rst: -------------------------------------------------------------------------------- 1 | m.qr 2 | #### 3 | 4 | Default: 5 | 6 | .. qr:: https://mcss.mosra.cz 7 | 8 | Large stuff inside: 9 | 10 | .. qr:: This QR code is quite large because it contains a lot of data and there 11 | is no way to make it behave differently so here you go. 12 | 13 | Large stuff inside, scaled down. 14 | 15 | .. qr:: This QR code is quite large because it contains a lot of data and there 16 | is no way to make it behave differently so here you go. 17 | :size: 100px 18 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_anchor_html_no_prefix_bug/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_enum/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_friends/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_anchor_in_both_group_and_namespace/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_code/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | EXAMPLE_PATH = . 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_image/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | IMAGE_PATH = . 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_math/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | ##! M_MATH_CACHE_FILE = 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_sections_headings/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h Warnings.h input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_derived/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_page/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.h input.md subdir/otherinput.md 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | -------------------------------------------------------------------------------- /doc/plugins/math-and-code-console-colors.ansi: -------------------------------------------------------------------------------- 1 | ██ ██ ██ ██ ██ ▓▓ ▒▒ 2 | 3 |     ░░ ▒▒ ▓▓ ██ 4 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_detailed/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_template_alias/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_minimal/indexpage.xml: -------------------------------------------------------------------------------- 1 | <?xml version='1.0' encoding='UTF-8' standalone='no'?> 2 | <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14"> 3 | <compounddef id="indexpage" kind="page"> 4 | <compoundname>index</compoundname> 5 | <title>My Project 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_builtin/stubs/inspect_builtin-36.pyi: -------------------------------------------------------------------------------- 1 | class BaseException: 2 | def with_traceback(self, *args): 3 | ... 4 | 5 | def __reduce__(self, *args): 6 | ... 7 | 8 | def __setstate__(self, *args): 9 | ... 10 | 11 | @property 12 | def __cause__(self): 13 | ... 14 | 15 | @property 16 | def __context__(self): 17 | ... 18 | 19 | @property 20 | def args(self): 21 | ... 22 | 23 | def log(*args): 24 | ... 25 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_create_intersphinx/inspect_create_intersphinx/pybind.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | namespace py = pybind11; 4 | 5 | namespace { 6 | 7 | void overloadedFunction(int, float) {} 8 | void overloadedFunction(int) {} 9 | 10 | } 11 | 12 | PYBIND11_MODULE(pybind, m) { 13 | m 14 | .def("overloaded_function", static_cast(&overloadedFunction)) 15 | .def("overloaded_function", static_cast(&overloadedFunction)); 16 | } 17 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_code_language/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | EXAMPLE_PATH = . 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_mishandled_macro_call/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_signals_slots/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | 17 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_variable_template/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_html/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | My Project 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_recursive/inspect_recursive/__init__.py: -------------------------------------------------------------------------------- 1 | """Recursive imports""" 2 | 3 | import inspect_recursive # Importing self, should get ignored 4 | 5 | class Foo: 6 | """A class""" 7 | 8 | from . import first 9 | 10 | # Importing a module twice, only one of them should be picked 11 | from . import second as b 12 | from . import second as a 13 | 14 | def foo() -> b.Bar: 15 | """Function that returns Foo""" 16 | 17 | def bar() -> a.Bar: 18 | """Function that also returns Foo""" 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_filename_case/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | CASE_SENSE_NAMES = NO 17 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_inline_namespace/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | ##! M_CLASS_TREE_EXPAND_LEVELS = 3 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_htmlonly_htmlinclude/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | EXAMPLE_PATH = . 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_internal/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | INTERNAL_DOCS = YES 17 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_search_opensearch/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | A project 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_template_fallback/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | My Project 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_nested_classes/stubs_nested_classes.py: -------------------------------------------------------------------------------- 1 | class Class: 2 | class Inner: 3 | class OneMore: 4 | ... 5 | 6 | @staticmethod 7 | def staticmethod(): 8 | ... 9 | 10 | class InnerAnother: 11 | class AndAnother: 12 | class YetAnother: 13 | DATA: float = 3 14 | 15 | AND_DATA: str = 'b' 16 | 17 | @property 18 | def property(self): 19 | ... 20 | 21 | class SomeOther: 22 | ... 23 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_math_cached/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | ##! M_MATH_CACHE_FILE = xml/math.cache 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_function_attributes_nospace/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_generated_doxyfile/xml/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | My Project 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_main_project_url/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | Your Brand 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_project_logo/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | Your Brand 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_single_column/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | My Project 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_search_binary/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | My Project 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_base_derived_in_root_namespace/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | SHOW_INCLUDE_FILES = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_namespace_members_in_file_scope/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | XML_NS_MEMB_FILE_SCOPE = YES 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_sections_headings/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | 5 | /** 6 | @brief A function 7 | 8 | # A top-level header 9 | 10 | ## A second-level header 11 | 12 | ### A third-level header 13 | 14 | @section foo-usage Usage 15 | 16 | This is usage. 17 | 18 | @subsection foo-usage-more More 19 | 20 | A subsection. 21 | 22 | @subsubsection foo-usage-more-more More. 23 | 24 | Mooore. 25 | 26 | @param bar A param. 27 | @return Does return something, yes. 28 | */ 29 | int foo(int bar); 30 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_base_derived_in_root_namespace/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief The file 3 | */ 4 | 5 | /** @brief A base class in the root namespace */ 6 | struct Base {}; 7 | 8 | /** @brief A namespace */ 9 | namespace Namespace { 10 | 11 | /** @brief A namespaced class with both base and derived in the root NS */ 12 | struct BothBaseAndDerivedInRootNamespace: Base {}; 13 | 14 | } 15 | 16 | /** @brief A derived class in the root namespace */ 17 | struct Derived: Namespace::BothBaseAndDerivedInRootNamespace {}; 18 | -------------------------------------------------------------------------------- /documentation/test_doxygen/ignored_languages/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = file.c file.cs file.java file.py 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_template_fallback/page.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block title %}HELLO THIS TEMPLATE OVERRIDES THINGS{% endblock %} 4 | 5 | {% block main %} 6 |

HELLO THIS TEMPLATE OVERRIDES THINGS

7 | {% if compound.brief %} 8 |

{{ compound.brief }}

9 | {% endif %} 10 |

But not all, the base.html is taken from the fallback.

11 | {% if compound.description %} 12 | {{ compound.description }} 13 | {% endif %} 14 | {% endblock %} 15 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_modules_in_namespace/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = file1.h file2.h file3.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | XML_NS_MEMB_FILE_SCOPE = YES 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_project_logo_main_project_url/indexpage.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | index 5 | Your Brand 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_namespace_members_in_file_scope_define_base_url/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | XML_NS_MEMB_FILE_SCOPE = YES 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/layout_navbar_html/Doxyfile: -------------------------------------------------------------------------------- 1 | XML_OUTPUT = 2 | 3 | ##! M_LINKS_NAVBAR1 = \ 4 | ##! "Say hello annotated" \ 5 | ##! "files" 6 | ##! M_LINKS_NAVBAR2 = \ 7 | ##! "pages This is an e-mail Another link namespaces" \ 8 | ##! "GitHub" 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_SEARCH_DISABLED = YES 13 | -------------------------------------------------------------------------------- /documentation/test_python/search/search/__init__.py: -------------------------------------------------------------------------------- 1 | import enum 2 | 3 | from . import sub, pybind 4 | 5 | class Foo: 6 | def a_method(self): 7 | pass 8 | 9 | @property 10 | def a_property(self): 11 | pass 12 | 13 | class Enum(enum.Enum): 14 | A_VALUE = 1 15 | ANOTHER = 2 16 | 17 | DATA_DECLARATION: int 18 | 19 | def a_function(): 20 | pass 21 | 22 | def func_with_params(a, b): 23 | pass 24 | 25 | class FooWithSlots: 26 | __slots__ = ('im_a_sloth',) 27 | 28 | im_a_sloth: bool 29 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/stubs/stubs_module_dependencies/sub/inner.py: -------------------------------------------------------------------------------- 1 | import another_module 2 | import unparsed_enum_module 3 | import unparsed_module 4 | from . import * 5 | from .. import * 6 | 7 | class EnumSubclass(unparsed_enum_module.UnparsedEnumClass): 8 | A_VALUE = 36 9 | 10 | def all_should_be_the_same_relative_type(a: Type, b: Type, c: Type): 11 | ... 12 | 13 | def foo(type_three_levels_up: Root, unparsed_type: unparsed_module.UnparsedName, enum = RootEnum.A_VALUE) -> another_module.Another: 14 | ... 15 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_builtin/stubs/inspect_builtin-310.pyi: -------------------------------------------------------------------------------- 1 | class BaseException: 2 | def with_traceback(self, *args): 3 | ... 4 | 5 | def __reduce__(self, *args): 6 | ... 7 | 8 | def __setstate__(self, *args): 9 | ... 10 | 11 | @property 12 | def __cause__(self): 13 | ... 14 | 15 | @property 16 | def __context__(self): 17 | ... 18 | 19 | @property 20 | def args(self): 21 | ... 22 | 23 | def pow(x, y, /): 24 | ... 25 | 26 | def log(*args): 27 | ... 28 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_create_intersphinx/inspect_create_intersphinx/__init__.py: -------------------------------------------------------------------------------- 1 | import enum 2 | 3 | from . import pybind 4 | 5 | def function(): pass 6 | 7 | class Class: 8 | @classmethod 9 | def class_method(cls): pass 10 | 11 | @staticmethod 12 | def static_method(): pass 13 | 14 | def method(self): pass 15 | 16 | @property 17 | def a_property(self): pass 18 | 19 | CLASS_DATA = 3 20 | 21 | class Enum(enum.Enum): 22 | ENUM_VALUE = 1 23 | 24 | MODULE_DATA = {} 25 | 26 | def _private_function(): pass 27 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_deprecated/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = Dir deprecated-page.dox 2 | RECURSIVE = YES 3 | AUTOLINK_SUPPORT = NO 4 | QUIET = YES 5 | GENERATE_HTML = NO 6 | GENERATE_LATEX = NO 7 | GENERATE_XML = YES 8 | XML_PROGRAMLISTING = NO 9 | CASE_SENSE_NAMES = YES 10 | 11 | ##! M_PAGE_FINE_PRINT = 12 | ##! M_THEME_COLOR = 13 | ##! M_FAVICON = 14 | ##! M_LINKS_NAVBAR1 = 15 | ##! M_LINKS_NAVBAR2 = 16 | ##! M_SEARCH_DISABLED = YES 17 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_broken_signatures/stubs/pybind_broken_signatures.pyi: -------------------------------------------------------------------------------- 1 | import typing 2 | 3 | def log(*args): 4 | ... 5 | 6 | @typing.overload 7 | def overload(arg0: int, /) -> None: 8 | ... 9 | 10 | @typing.overload 11 | def overload(*args): 12 | ... 13 | 14 | @typing.overload 15 | def overload(*args): 16 | ... 17 | 18 | @typing.overload 19 | def overload2(arg0: int, /) -> None: 20 | ... 21 | 22 | @typing.overload 23 | def overload2(*args): 24 | ... 25 | 26 | @typing.overload 27 | def overload2(*args): 28 | ... 29 | -------------------------------------------------------------------------------- /pelican-theme/templates/pagination.html: -------------------------------------------------------------------------------- 1 | {% if DEFAULT_PAGINATION %} 2 |
3 | {%- if articles_page.has_previous() %}« {% if ARTICLE_ORDER_BY == "date" %}older{% else %}newer{% endif %} articles | {% endif -%} 4 | page {{ articles_page.number }} 5 | {%- if articles_page.has_next() %} | {% if ARTICLE_ORDER_BY == "date" %}newer{% else %}older{% endif %} articles »{% endif -%} 6 |
7 | {% endif %} 8 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_index/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | # Keeping the default M_PAGE_FINE_PRINT to test that no "Doxygen version 0" is 10 | # added to the footer. 11 | 12 | ##! M_THEME_COLOR = 13 | ##! M_FAVICON = 14 | ##! M_LINKS_NAVBAR1 = 15 | ##! M_LINKS_NAVBAR2 = 16 | ##! M_SEARCH_DISABLED = YES 17 | -------------------------------------------------------------------------------- /documentation/test_python/pybind_name_mapping/sub.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | struct Foo { 4 | static Foo aThing() { return {}; } 5 | }; 6 | 7 | PYBIND11_MODULE(_sub, m) { 8 | pybind11::class_{m, "Foo", "A class, renamed from Foo to Class"} 9 | .def("a_thing", &Foo::aThing, "A method"); 10 | 11 | pybind11::module bar = m.def_submodule("bar"); 12 | bar.doc() = "This submodule is renamed from bar to submodule and should have a function member."; 13 | bar.def("foo", [](Foo, int a) { return a*2; }, "A function"); 14 | } 15 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/opensearch.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | {{ PROJECT_NAME }}{% if PROJECT_BRIEF %} {{ PROJECT_BRIEF }}{% endif %} 4 | Search {{ PROJECT_NAME }} documentation 5 | {% if FAVICON %} 6 | {{ SEARCH_BASE_URL|urljoin(FAVICON[0])|e }} 7 | {% endif %} 8 | 9 | 10 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_heading/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | # So the ==== is treated as brief. Ugh. 17 | JAVADOC_AUTOBRIEF = YES 18 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_hr/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | # So the comment on top is treated as a brief 17 | JAVADOC_AUTOBRIEF = YES 18 | -------------------------------------------------------------------------------- /documentation/templates/python/opensearch.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | {{ PROJECT_TITLE }}{% if PROJECT_SUBTITLE %} {{ PROJECT_SUBTITLE }}{% endif %} 4 | Search {{ PROJECT_TITLE }} documentation 5 | {% if FAVICON %} 6 | {{ SEARCH_BASE_URL|urljoin(FAVICON[0])|e }} 7 | {% endif %} 8 | 9 | 10 | -------------------------------------------------------------------------------- /pelican-theme/test/page_landing/page.rst: -------------------------------------------------------------------------------- 1 | A page title that displays only in title 2 | ######################################## 3 | 4 | :cover: {static}/ship.jpg 5 | :header: This shouldn't be visible anywhere. 6 | :footer: This is visible on the bottom. 7 | :landing: 8 | .. container:: m-row 9 | 10 | .. container:: m-col-l-6 m-push-l-1 m-col-m-7 m-nopadb 11 | 12 | .. raw:: html 13 | 14 |

A page title that displays on page

15 | 16 | Some text. Linking `to self <{filename}/page.rst>`_. 17 | 18 | Some page text. 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_enum/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file. 3 | */ 4 | 5 | /** @brief Strongly-typed enum */ 6 | enum class Boolean: unsigned char { 7 | True = 7, /**< True. */ 8 | False, /**< False? */ 9 | FileNotFound = -1 /**< Haha. */ 10 | }; 11 | 12 | /** @brief Typed enum */ 13 | enum E: int { 14 | Value = 42 /**< Value */ 15 | }; 16 | 17 | /** @brief Strong implicitly typed enum */ 18 | enum class F {}; 19 | 20 | enum: long { 21 | /** @brief Constant in an unnamed typed enum */ 22 | Unnamed = -1337 23 | }; 24 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_string/inspect_string/another_module.py: -------------------------------------------------------------------------------- 1 | """Another module""" 2 | 3 | # This one is a module that shouldn't be exposed 4 | import enum 5 | 6 | # This one is a package that shouldn't be exposed 7 | import xml 8 | 9 | # These are variables from an external modules, shouldn't be exposed either 10 | from re import I 11 | 12 | # TODO: there's no way to tell where a variable of a builtin type comes from, 13 | # so this would be exposed. The only solution is requiring a presence of an 14 | # external docstring I'm afraid. 15 | #from math import pi 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_multiline/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | # So the two lines on top are treated as brief. Wtf. 17 | JAVADOC_AUTOBRIEF = YES 18 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_tagfile/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | TAGFILES = ../../../doc/documentation/corrade.tag=https://doc.magnum.graphics/corrade/ 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = First.cpp First.h Second.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | # otherwise it links to Second.h and Union, DO NOT WANT 17 | AUTOLINK_SUPPORT = NO 18 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes_undocumented_files/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = First.h Second.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | 17 | AUTOLINK_SUPPORT = NO # otherwise it links to Second.h, DO NOT WANT 18 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_sections_headings/Warnings.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file producing warnings 3 | */ 4 | 5 | /** 6 | @brief This produces warnings 7 | 8 | # Markdown heading 1 9 | 10 | ## Markdown heading 2 11 | 12 | ### Markdown heading 3 13 | 14 | #### Markdown heading 4 that's rendered the same as 3 15 | 16 | ##### Markdown heading 5 that's rendered the same as 3 17 | 18 | ###### Markdown heading 6 that's rendered the same as 3 19 | 20 | Markdown heading, underlined, is misparsed 21 | ########################################## 22 | 23 | */ 24 | void bar(int foo); 25 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_function_variable_attributes/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.h 2 | AUTOLINK_SUPPORT = NO 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | 17 | INHERIT_DOCS = NO 18 | EXTRACT_PRIV_VIRTUAL = YES 19 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/categories/a-category.rst: -------------------------------------------------------------------------------- 1 | A category name, displayed on top of the category badge/details 2 | ############################################################### 3 | 4 | :image: {static}/category.jpg 5 | :description: Category description, used for a tag. 6 | :summary: Category summary, used for the social tags. 7 | :badge: Contents of the badge, displayed at article bottom. 8 | `Link to the category. <{category}a-category>`_ 9 | 10 | Contents of category details, displayed on top of the category page. 11 | `Link. `_ 12 | -------------------------------------------------------------------------------- /plugins/m/test/metadata/authors/an-author.rst: -------------------------------------------------------------------------------- 1 | Author name, displayed on top of the author page 2 | ################################################ 3 | 4 | :twitter: @czmosra 5 | :twitter_id: 1537427036 6 | :image: {static}/mosra.jpg 7 | :description: Author description, used for a tag. 8 | :summary: Author summary, used for the social tags. 9 | :badge: Contents of the badge, displayed at article bottom. 10 | `Link to the author. <{author}an-author>`_ 11 | 12 | Contents of author details, displayed on top of the author page. 13 | `Link. `_ 14 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_modules_in_namespace/file3.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief Include file with some stuff that belongs to group 1 and group 2 3 | */ 4 | 5 | namespace Namespace { 6 | 7 | /** @ingroup group2 8 | @brief Lets define yet another function 9 | 10 | Also with detailed description. 11 | */ 12 | void anotherFunction(); 13 | 14 | /** @ingroup group1 15 | @brief And another function here 16 | 17 | Also with detailed description. 18 | */ 19 | void moreFunction(); 20 | 21 | /** @ingroup group2 22 | @brief A define 23 | 24 | With details. 25 | */ 26 | #define A_DEFINE 27 | 28 | } 29 | -------------------------------------------------------------------------------- /documentation/test_doxygen/undocumented/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = Directory 2 | RECURSIVE = YES 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | 14 | XML_NS_MEMB_FILE_SCOPE = YES 15 | ##! M_LINKS_NAVBAR1 = \ 16 | ##! modules \ 17 | ##! namespaces 18 | ##! M_SEARCH_DOWNLOAD_BINARY = YES 19 | ##! M_SHOW_UNDOCUMENTED = YES 20 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_builtin/stubs/inspect_builtin.pyi: -------------------------------------------------------------------------------- 1 | class BaseException: 2 | def add_note(self, *args): 3 | ... 4 | 5 | def with_traceback(self, *args): 6 | ... 7 | 8 | def __reduce__(self, *args): 9 | ... 10 | 11 | def __setstate__(self, *args): 12 | ... 13 | 14 | @property 15 | def __cause__(self): 16 | ... 17 | 18 | @property 19 | def __context__(self): 20 | ... 21 | 22 | @property 23 | def args(self): 24 | ... 25 | 26 | def pow(x, y, /): 27 | ... 28 | 29 | def log(*args): 30 | ... 31 | -------------------------------------------------------------------------------- /documentation/test_python/link_formatting/link_formatting/__init__.py: -------------------------------------------------------------------------------- 1 | """This is a module.""" 2 | 3 | import enum 4 | 5 | from . import sub, pybind 6 | 7 | class Enum(enum.Enum): 8 | """An enum""" 9 | 10 | FIRST_VALUE = 1 11 | SECOND_VALUE = 2 12 | 13 | SOME_DATA: Enum = Enum.FIRST_VALUE 14 | 15 | class Class: 16 | """This is a nice class.""" 17 | 18 | class Sub: 19 | """And a nice subclass, oh.""" 20 | 21 | @property 22 | def property(self) -> Enum: 23 | """A property.""" 24 | 25 | def function(a: Enum = Enum.SECOND_VALUE) -> Class: 26 | """A function.""" 27 | -------------------------------------------------------------------------------- /pelican-theme/test/page_passthrough/page.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | WebGL Demo Page 6 | 7 | 8 | 9 | 10 | 11 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | -------------------------------------------------------------------------------- /plugins/m/test/gh/page.rst: -------------------------------------------------------------------------------- 1 | m.gh 2 | #### 3 | 4 | .. role:: gh-flat(gh) 5 | :class: m-flat 6 | 7 | - Profile link: :gh:`mosra` 8 | - Repository link: :gh:`mosra/m.css` 9 | - Commit link: :gh:`mosra/m.css@4d362223f107cffd8731a0ea031f9353a0a2c7c4` 10 | - Issue/PR link: :gh:`mosra/magnum#123` 11 | - Tree link: :gh:`mosra/m.css$next` 12 | - Tag link: :gh:`mosra/magnum^snapshot-2015-05` 13 | - File link: :gh:`mosra/m.css$master/css/m-dark.css` 14 | - Arbitrary link: :gh:`mosra/magnum/graphs/contributors` 15 | - :gh:`Link with custom title ` 16 | - Flat link: :gh-flat:`mosra` 17 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_code_language/console-colors.ansi: -------------------------------------------------------------------------------- 1 | ██ ██ ██ ██ ██ ▓▓ ▒▒ 2 | 3 | Leading zeros: ▒▒ ▒▒ 4 | 5 |     ░░ ▒▒ ▓▓ ██ 6 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_in_navbar/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = "page-in-navbar pages page-b" \ 13 | ##! "page-b" 14 | ##! M_LINKS_NAVBAR2 = "page-b" \ 15 | ##! "page-in-navbar page-b files" 16 | ##! M_SEARCH_DISABLED = YES 17 | -------------------------------------------------------------------------------- /pelican-theme/test/page_passthrough/input/page.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | WebGL Demo Page 5 | 6 | 10 | 12 | 13 | 18 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /documentation/templates/python/details-data.html: -------------------------------------------------------------------------------- 1 |
2 |

3 | {{ prefix }}{{ data.name }}{% if data.type_link %}: {{ data.type_link }}{% endif %} 4 | {# the empty line needs to be here to prevent the lines from merging #} 5 | 6 |

7 | {% if data.summary %} 8 |

{{ data.summary }}

9 | {% endif %} 10 | {% if data.content %} 11 | {{ data.content }} 12 | {% endif %} 13 |
14 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_crazy_template_params/File.h: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | /** @file 4 | * @brief A file 5 | */ 6 | 7 | /** 8 | @brief Templates can get quite crazy 9 | @tparam T yes they 10 | @param value can 11 | */ 12 | template && std::is_class_v>* = nullptr> void foo(T* value); 13 | 14 | /** 15 | @brief Templates can get quite crazy 16 | @tparam T yes they 17 | @tparam ptr absolutely 18 | @param value can 19 | */ 20 | template && std::is_class_v>* ptr = nullptr> void bar(T* value); 21 | 22 | } 23 | -------------------------------------------------------------------------------- /documentation/test_doxygen/example/input.dox: -------------------------------------------------------------------------------- 1 | /** @page page A page 2 | 3 | Go here: @subpage example 4 | */ 5 | 6 | /** @page example The Example 7 | 8 | See here: 9 | 10 | - @ref path-prefix/CMakeLists.txt 11 | - @ref path-prefix/configure.h.cmake 12 | - @ref path-prefix/main.cpp 13 | 14 | @example path-prefix/CMakeLists.txt @m_examplenavigation{example,path-prefix/} @m_footernavigation 15 | @example path-prefix/configure.h.cmake @m_examplenavigation{example,path-prefix/} @m_footernavigation 16 | @example path-prefix/main.cpp @m_examplenavigation{example,path-prefix/} @m_footernavigation 17 | @example a.txt 18 | */ 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_blockquote/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | # In this case neither JAVADOC_AUTOBRIEF nor QT_AUTOBRIEF needs to be set to 17 | # recognize the first line of /// comments as brief 18 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/group.html: -------------------------------------------------------------------------------- 1 | {% extends 'base-reference.html' %} 2 | 3 | {% block title %}{% set j = joiner(' » ') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} module | {{ super() }}{% endblock %} 4 | 5 | {% block header %} 6 |

7 | {% for name, target in compound.breadcrumb[:-1] %} 8 | {{ name }} » 9 | {% endfor %} 10 | {{ compound.breadcrumb[-1][0] }} module{% if compound.since %} {{ compound.since }}{% endif %}

11 | {% endblock %} 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_autobrief_cpp_comments/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = File.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | # In this case neither JAVADOC_AUTOBRIEF nor QT_AUTOBRIEF needs to be set to 17 | # recognize the first line of /// comments as brief 18 | -------------------------------------------------------------------------------- /documentation/templates/python/page.html: -------------------------------------------------------------------------------- 1 | {% extends 'base.html' %} 2 | 3 | {% block title %}{% set j = joiner('.') %}{% for name, _ in page.breadcrumb %}{{ j() }}{{ name }}{% endfor %} | {{ super() }}{% endblock %} 4 | 5 | {% block main %} 6 |

7 | {%+ for name, target in page.breadcrumb[:-1] %}{{ name }}.{% endfor %}{{ page.breadcrumb[-1][0] }} 8 |

9 | {% if page.summary %} 10 |

{{ page.summary }}

11 | {% endif %} 12 | {% if page.content %} 13 | {{ page.content }} 14 | {% endif %} 15 | {% endblock %} 16 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes_templated/First.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief First file 3 | */ 4 | 5 | /** 6 | @brief This namespace is spread over two files 7 | 8 | So it has per-entry includes next to template info, properly expanding the 9 | brief-only docs into detailed ones. 10 | */ 11 | namespace Spread { 12 | 13 | /** @brief A template alias */ 14 | template using Alias = T; 15 | 16 | /** @brief A templated function */ 17 | template void bar(); 18 | 19 | } 20 | 21 | /** 22 | @brief A templated struct 23 | 24 | Has global include info next to the template info. 25 | */ 26 | template struct Struct {}; 27 | -------------------------------------------------------------------------------- /doc/plugins/math-and-code-selfcontained.py: -------------------------------------------------------------------------------- 1 | """ 2 | This is a reST markup explaining the following code, compatible with 3 | `Sphinx Gallery `_. 4 | """ 5 | 6 | # You can convert the file to a Jupyter notebook using the 7 | # sphx_glr_python_to_jupyter.py utility from Sphinx Gallery. 8 | 9 | import math 10 | 11 | sin = math.sin(0.13587) 12 | print(sin) 13 | 14 | #%% 15 | # And a sum with itself turns it into two sins, because the following holds: 16 | # 17 | # .. math:: 18 | # 19 | # 2 a = a + a 20 | # 21 | 22 | two_sins = sin + sin 23 | if two_sins != 2*sin: 24 | print("Assumptions broken. Restart the universe.") 25 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_footer_navigation/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | IMAGE_PATH = . 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | ##! M_PAGE_FINE_PRINT = 11 | ##! M_THEME_COLOR = 12 | ##! M_FAVICON = 13 | ##! M_LINKS_NAVBAR1 = 14 | ##! M_LINKS_NAVBAR2 = 15 | ##! M_SEARCH_DISABLED = YES 16 | 17 | ALIASES = \ 18 | "m_footernavigation=@xmlonly@endxmlonly" 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/doxyfile/Doxyfile-legacy: -------------------------------------------------------------------------------- 1 | # Includes 2 | @INCLUDE = Doxyfile-another 3 | 4 | # Quotes 5 | PROJECT_BRIEF = "is cool" 6 | 7 | # Multiple lines 8 | HTML_EXTRA_FILES = \ 9 | css \ 10 | "another.png" \ 11 | \ 12 | "hello" 13 | 14 | # Adding 15 | HTML_EXTRA_STYLESHEET = a.css 16 | HTML_EXTRA_STYLESHEET += b.css 17 | 18 | # Escaping 19 | M_PAGE_HEADER = 'this is "quotes" \'apostrophes\'' 20 | M_PAGE_FINE_PRINT = "this is \"quotes\"" 21 | 22 | # Commented with a hashbang 23 | ##! M_LINKS_NAVBAR1 = pages \ 24 | ##! modules 25 | 26 | # Commented with a hashbang and no space 27 | ##!M_LINKS_NAVBAR2 = files \ 28 | ##!annotated 29 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/file.html: -------------------------------------------------------------------------------- 1 | {% extends 'base-reference.html' %} 2 | 3 | {% block title %}{% set j = joiner('/') %}{% for name, _ in compound.breadcrumb %}{{ j() }}{{ name }}{% endfor %} file | {{ super() }}{% endblock %} 4 | 5 | {% block header %} 6 |

7 | {%+ for name, target in compound.breadcrumb[:-1] %}{{ name }}/{% endfor %}{{ compound.breadcrumb[-1][0] }} file{% if compound.since %} {{ compound.since }}{% endif %} 8 | {# need an explicit space here otherwise the newline gets removed #} 9 | 10 |

11 | {% endblock %} 12 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_value_formatting/stubs/inspect_value_formatting.pyi: -------------------------------------------------------------------------------- 1 | import enum 2 | 3 | class MyEnum(enum.Enum): 4 | YAY = 2 5 | 6 | class Foo: 7 | ... 8 | 9 | AN_UNREPRESENTABLE_VALUE: ... 10 | 11 | A_FALSE_VALUE = False 12 | 13 | A_NONE_VALUE = None 14 | 15 | A_ZERO_VALUE = 0 16 | 17 | ENUM_THING = MyEnum.YAY 18 | 19 | LARGE_VALUE_WILL_BE_AN_ELLIPSIS = ... 20 | 21 | def basics(string_param = 'string', tuple_param = (3, 5), float_param = 1.2, unrepresentable_param = ...): 22 | ... 23 | 24 | def setup_callback(unknown_function_is_an_ellipsis = ..., builtin_function_is_an_ellipsis = ..., lambda_is_an_ellipsis = ...): 25 | ... 26 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes_disabled/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = ../compound_includes/First.h ../compound_includes/Second.h 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | 16 | AUTOLINK_SUPPORT = NO # otherwise it links to Second.h, DO NOT WANT 17 | SHOW_INCLUDE_FILES = NO # explicitly disabled 18 | -------------------------------------------------------------------------------- /documentation/templates/doxygen/dir.html: -------------------------------------------------------------------------------- 1 | {% extends 'base-reference.html' %} 2 | 3 | {% block title %}{% for name, _ in compound.breadcrumb %}{{ name }}/{% endfor %} directory | {{ super() }}{% endblock %} 4 | 5 | {% block header %} 6 |

7 | {%+ for name, target in compound.breadcrumb[:-1] %}{{ name }}/{% endfor %}{{ compound.breadcrumb[-1][0] }}/ directory{% if compound.since %} {{ compound.since }}{% endif %} 8 | {# need an explicit space here otherwise the newline gets removed #} 9 | 10 |

11 | {% endblock %} 12 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_listing/input.dox: -------------------------------------------------------------------------------- 1 | /** @namespace Root 2 | * @brief Root namespace 3 | */ 4 | 5 | /** @dir Directory 6 | * @brief Directory 7 | */ 8 | /** @namespace Root::Directory 9 | * @brief Namespace in directory 10 | */ 11 | 12 | /** @dir Directory/Sub 13 | * @brief Subdirectory 14 | */ 15 | /** @namespace Root::Directory::Sub 16 | * @brief Namespace in subdirectory 17 | */ 18 | 19 | /** @dir Another 20 | * @brief Another directory 21 | */ 22 | /** @namespace Another 23 | * @brief Another namespace 24 | */ 25 | 26 | /** @page page-no-toc Page without TOC 27 | 28 | @section section-notoc A section that doesn't go into TOC 29 | 30 | */ 31 | -------------------------------------------------------------------------------- /documentation/test_doxygen/page_empty_page/input.md: -------------------------------------------------------------------------------- 1 | @ingroup bla 2 | 3 | [comment]: # (The `ingroup` statement above avoids the generation of an empty page for this file.) 4 | [comment]: # (The actual group we add the file to is irrelevant, nothing is actually added.) 5 | [comment]: # (Doxygen will actually create xml/group__bla_md_input.xml, but we want to avoid) 6 | [comment]: # (creating html/group__bla_md_input.html, and listing `input` on the list of pages.) 7 | 8 | @class Foo::Bar 9 | 10 | This is the detailed description for class `Foo::Bar``. 11 | We put it in a separate file to not clutter the header file too much. 12 | Because this is a really loooong description! 13 | -------------------------------------------------------------------------------- /doc/plugins/math-and-code-console.ansi: -------------------------------------------------------------------------------- 1 | ![mosra@don-perverzo m.css]$ ls 2 | CONTRIBUTING.rst CREDITS.rst doc plugins README.rst 3 | COPYING css documentation pelican-theme site 4 | 5 | ASan reports: 6 | 7 | =>0x0c287fff8030: 00[fc]fc fc fc fc fc fc fc fc fc fa fa fa fa fa 8 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_type_links/inspect_type_links/first/sub.py: -------------------------------------------------------------------------------- 1 | """Submodule""" 2 | 3 | from inspect_type_links import first 4 | 5 | class Foo: 6 | """A class in the submodule""" 7 | 8 | def reference_self(a: 'first.sub.Foo'): 9 | """A method referencing a type in this submodule""" 10 | 11 | def reference_parent(a: first.Foo, b: first.Foo): 12 | """A method referencing a type in a parent module""" 13 | 14 | def reference_self(a: Foo, b: 'first.sub.Foo'): 15 | """A function referencing a type in this submodule""" 16 | 17 | def reference_parent(a: first.Foo, b: first.Foo): 18 | """A function referencing a type in a parent module""" 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_math_code_fallback/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = input.dox 2 | QUIET = YES 3 | GENERATE_HTML = NO 4 | GENERATE_LATEX = NO 5 | GENERATE_XML = YES 6 | XML_PROGRAMLISTING = NO 7 | CASE_SENSE_NAMES = YES 8 | 9 | ##! M_PAGE_FINE_PRINT = 10 | ##! M_THEME_COLOR = 11 | ##! M_FAVICON = 12 | ##! M_LINKS_NAVBAR1 = 13 | ##! M_LINKS_NAVBAR2 = 14 | ##! M_SEARCH_DISABLED = YES 15 | ##! M_MATH_CACHE_FILE = 16 | ##! M_MATH_RENDER_AS_CODE = YES 17 | 18 | ALIASES = \ 19 | "m_class{1}=@xmlonly@endxmlonly" 20 | -------------------------------------------------------------------------------- /documentation/test_doxygen/search_long_suffix_length/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | 5 | typedef int ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways; 6 | 7 | /** @brief One fun function */ 8 | bool aVeryLongFunctionName(ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways a, ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways b, ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways c, ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways d, ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways e, ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways f, ThisIsALongTypeForWhichIWantDoxygenToCalculateTheSameHashAlways g); 9 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_math/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | Here's a block formula: 4 | 5 | @f[ 6 | \hat q = [\boldsymbol 0, 1] + \epsilon [\frac{\boldsymbol v}{2}, 0] 7 | @f] 8 | 9 | And @f$ \hat q @f$ is how quaternion is denoted. 10 | 11 | @f[ 12 | a^2 + b^2 = c^2 13 | @f] 14 | 15 | @f$c^2@f$ should be part of a new paragraph, not stuck out of it. The following 16 | formula has a custom environment: 17 | 18 | \f{eqnarray*}{ 19 | g &=& \frac{Gm_2}{r^2} \\ 20 | &=& 9.82066032\,\mbox{m/s}^2 21 | \f} 22 | 23 | */ 24 | 25 | /** @page error Error 26 | 27 | This will blow up when rendered and should print a warning to output: 28 | 29 | @f[ 30 | \hat{ 31 | @f] 32 | 33 | */ 34 | -------------------------------------------------------------------------------- /documentation/templates/python/entry-property.html: -------------------------------------------------------------------------------- 1 | 2 | {{ property.name }}{% if property.type_link %}: {{ property.type_link }}{% endif %} {% if property.is_gettable and property.is_settable %}get set{% elif property.is_gettable %}get{% else %}set{% endif %}{% if property.is_deletable %} del{% endif %} 3 | 4 |
{{ property.summary }}
5 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_includes_strip_from_path/input.dox: -------------------------------------------------------------------------------- 1 | /* The top-level project/ directory shouldn't be shown anywhere. Also, the 2 | `input.dox` which this is generated from shouldn't be shown anywhere, nor it 3 | should expand the file tree one level up. */ 4 | 5 | /** @dir project/include 6 | * @brief A top-level include directory 7 | * 8 | * Should be shown only as `include/`. The file tree also shouldn't list 9 | * the top-level `project/` directory. 10 | */ 11 | 12 | /** @dir project/include/Library 13 | * @brief A library include directory 14 | * 15 | * Should be shown only only as `include/Library/`. The file tree also 16 | * shouldn't list the top-level `project/` directory. 17 | */ 18 | -------------------------------------------------------------------------------- /documentation/templates/python/entry-enum.html: -------------------------------------------------------------------------------- 1 | 2 | {% set j = joiner('\n ') %} 3 | class {{ enum.name }}{% if enum.base_link %}({{ enum.base_link }}){% endif %}: {% for value in enum.values %}{{ j() }}{{ value.name }}{% if value.value is not none %} = {{ value.value }}{% endif %}{% endfor %} 4 | 5 |
{{ enum.summary }}
6 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_modules_in_namespace/file2.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief Include file for group 2 3 | */ 4 | 5 | namespace Namespace { 6 | 7 | /** @defgroup group2 Second group 8 | * @brief The second group, containing some more functions 9 | * @{ 10 | */ 11 | 12 | /** 13 | @brief Yet another function 14 | 15 | With detailed description. 16 | */ 17 | void function3(); 18 | 19 | /** 20 | @brief And even more functions 21 | 22 | Also with detailed description. 23 | */ 24 | void function4(); 25 | 26 | /** 27 | @brief An enum 28 | 29 | With details. 30 | */ 31 | enum Enum {}; 32 | 33 | /* Since 1.8.17, the original short-hand group closing doesn't work anymore. 34 | FFS. */ 35 | /** 36 | * @} 37 | */ 38 | 39 | } 40 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_html_escape/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = page.dox Fi&le.h 2 | IMAGE_PATH = . 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | # Needed to make the @struct recognized by m.css, otherwise it's 11 | # ignored as the directory structure gets lost with empty STRIP_FROM_INC_PATH 12 | STRIP_FROM_INC_PATH = . 13 | 14 | ##! M_PAGE_FINE_PRINT = 15 | ##! M_THEME_COLOR = 16 | ##! M_FAVICON = 17 | ##! M_LINKS_NAVBAR1 = files 18 | ##! M_LINKS_NAVBAR2 = pages annotated 19 | ##! M_SEARCH_DISABLED = YES 20 | -------------------------------------------------------------------------------- /documentation/test_python/stubs_module_dependencies/stubs_module_dependencies/sub/inner.py: -------------------------------------------------------------------------------- 1 | import stubs_module_dependencies 2 | from stubs_module_dependencies import Root, RootEnum, sub 3 | 4 | from . import Type 5 | 6 | import another_module 7 | import unparsed_enum_module 8 | import unparsed_module 9 | 10 | class EnumSubclass(unparsed_enum_module.UnparsedEnumClass): 11 | A_VALUE = 36 12 | 13 | def all_should_be_the_same_relative_type(a: stubs_module_dependencies.sub.Type, 14 | b: sub.Type, 15 | c: Type): 16 | ... 17 | 18 | def foo(type_three_levels_up: Root, unparsed_type: unparsed_module.UnparsedName, enum = RootEnum.A_VALUE) -> another_module.Another: 19 | ... 20 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_dot/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | Note: the test uses DejaVu Sans instead of Source Sans Pro in order to have 4 | predictable rendering on the CIs. 5 | 6 | @dot 7 | digraph Basics { 8 | rankdir=LR 9 | 10 | a [style=filled shape=rect] 11 | b [peripheries=2 shape=circle] 12 | c [shape=ellipse] 13 | a -> b 14 | b -> c [label="0" fontsize=40] 15 | c -> c [label="1"] 16 | } 17 | @enddot 18 | 19 | @dotfile colors.dot 20 | 21 | @dot "A graph" width=5rem 22 | strict graph "" { 23 | a -- b 24 | a -- b 25 | } 26 | @enddot 27 | 28 | @dotfile ab.dot "A graph" height=5rem 29 | */ 30 | 31 | /** @page warnings 32 | 33 | This file doesn't exist: 34 | 35 | @dotfile nonexistent.dot 36 | */ 37 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_sections_headings/input.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage 2 | 3 | @section section Page section 4 | 5 | Text. 6 | 7 | @subsection subsection Page subsection 8 | 9 | Text! 10 | 11 | @subsubsection subsubsection Sub-sub section 12 | 13 | Reference to @ref subsection "a page subsection" and @ref subsubsection. 14 | 15 | */ 16 | 17 | /** @page warnings Content that produces warnings 18 | 19 | # Markdown heading 1 20 | 21 | ## Markdown heading 2 22 | 23 | ### Markdown heading 3 24 | 25 | #### Markdown heading 4 26 | 27 | ##### Markdown heading 5 28 | 29 | ###### Markdown heading 6 that's rendered the same as 5 30 | 31 | Markdown heading, underlined, is misparsed 32 | ########################################## 33 | 34 | */ 35 | -------------------------------------------------------------------------------- /documentation/test_doxygen/cpp_function_attributes_nospace/input.h: -------------------------------------------------------------------------------- 1 | /** @brief Base class */ 2 | class Base { 3 | virtual void doThing()noexcept; 4 | virtual void doAnotherThing(); 5 | virtual void doYetAnotherThing(); 6 | }; 7 | 8 | /** @brief Keywords without spaces */ 9 | struct Foo: Base { 10 | /** @brief Final w/o override (will cause a compiler warning), w/o a space */ 11 | void doThing() &&noexcept final; 12 | 13 | /** @brief Do more things, without a space */ 14 | void doMoreStuff() &&noexcept(false); 15 | 16 | /** @brief Final override, without a space */ 17 | void doAnotherThing() &&final override; 18 | 19 | /** @brief Override final, without a space */ 20 | void doYetAnotherThing() &&override final; 21 | }; 22 | -------------------------------------------------------------------------------- /documentation/test_python/inspect_type_links/index.rst: -------------------------------------------------------------------------------- 1 | Type links 2 | ########## 3 | 4 | External links with correct class: :ref:`typing.Tuple` or :ref:`str` (tested 5 | extensively in the ``m.sphinx`` tests). 6 | 7 | Internal links with ``m-doc`` implicit: 8 | 9 | - Module: :ref:`inspect_type_links` 10 | - Class: :ref:`inspect_type_links.first.Foo` 11 | - Function: :ref:`inspect_type_links.first.Foo.reference_inner()` 12 | 13 | - without ``()``: :ref:`inspect_type_links.first.Foo.reference_inner` 14 | 15 | - Property: :ref:`inspect_type_links.second.Foo.type_property` 16 | - Enum: :ref:`inspect_type_links.second.Enum` 17 | - Enum value: :ref:`inspect_type_links.second.Enum.SECOND` 18 | - Data: :ref:`inspect_type_links.second.TYPE_DATA` 19 | -------------------------------------------------------------------------------- /documentation/test_doxygen/contents_unexpected_sections/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | @brief A file 3 | 4 | @return Files don't return anything. 5 | 6 | @section section A section 7 | 8 | @tparam huh Sections shouldn't have template params. 9 | */ 10 | 11 | /** 12 | @brief An enum 13 | @param what No, enums don't have params. 14 | */ 15 | enum Foo { 16 | /** 17 | * @return Neither this. 18 | */ 19 | Value = 32 20 | }; 21 | 22 | /** 23 | @brief A variable 24 | @exception no Variables don't throw exceptions. 25 | */ 26 | int variable; 27 | 28 | /** 29 | @brief A typedef 30 | @return Typedefs don't have return values. 31 | */ 32 | typedef Foo Bar; 33 | 34 | /** 35 | @brief A define 36 | @tparam T Defines don't have templates. 37 | */ 38 | #define FOOBAR 3 39 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_no_full_path_names/doc/Doxyfile: -------------------------------------------------------------------------------- 1 | INPUT = ../project/root.h ../project/directory/sub.h 2 | OUTPUT_DIRECTORY = .. 3 | QUIET = YES 4 | GENERATE_HTML = NO 5 | GENERATE_LATEX = NO 6 | GENERATE_XML = YES 7 | XML_PROGRAMLISTING = NO 8 | CASE_SENSE_NAMES = YES 9 | 10 | # If the three below would be set instead, it wouldn't warn 11 | FULL_PATH_NAMES = NO 12 | # FULL_PATH_NAMES = YES 13 | # STRIP_FROM_PATH = .. 14 | # STRIP_FROM_INC_PATH = .. 15 | 16 | ##! M_PAGE_FINE_PRINT = 17 | ##! M_THEME_COLOR = 18 | ##! M_FAVICON = 19 | ##! M_LINKS_NAVBAR1 = 20 | ##! M_LINKS_NAVBAR2 = 21 | ##! M_SEARCH_DISABLED = YES 22 | -------------------------------------------------------------------------------- /documentation/test_doxygen/compound_namespace_members_in_file_scope_define_base_url/File.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | * @brief A file 3 | */ 4 | 5 | /* Preprocessor defines are usually first in the XML file, but if there is a 6 | user-defined group, that is first. That triggers a corner case in define ID 7 | extraction -- parsing the var will set current base url to namespaceNS, 8 | but that shouldn't trigger any error when parsing the define after. */ 9 | 10 | /** @brief A namespace */ 11 | namespace NS { 12 | 13 | /** @{ @name Variables */ 14 | 15 | int var; /**< @brief A variable */ 16 | 17 | /* Since 1.8.17, the original short-hand group closing doesn't work anymore. 18 | FFS. */ 19 | /** 20 | * @} 21 | */ 22 | 23 | } 24 | 25 | /** @brief A define */ 26 | #define A_DEFINE 27 | --------------------------------------------------------------------------------