Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 666 for mkdocs (0.12 seconds)

  1. docs/en/mkdocs.yml

    INHERIT: ../en/mkdocs.env.yml
    site_name: FastAPI
    site_description: FastAPI framework, high performance, easy to learn, fast to code, ready for production
    site_url: https://fastapi.tiangolo.com/
    theme:
      name: material
      custom_dir: ../en/overrides
      palette:
      - media: (prefers-color-scheme)
        toggle:
          icon: material/lightbulb-auto
          name: Switch to light mode
      - media: '(prefers-color-scheme: light)'
        scheme: default
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 10:44:55 GMT 2025
    - 9.2K bytes
    - Click Count (0)
  2. docs/en/mkdocs.env.yml

    # Define this here and not in the main mkdocs.yml file because that one is auto
    # updated and written, and the script would remove the env var
    markdown_extensions:
      pymdownx.highlight:
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Thu Nov 20 10:45:16 GMT 2025
    - 223 bytes
    - Click Count (0)
  3. requirements-docs.txt

    -e .
    -r requirements-docs-tests.txt
    mkdocs-material==9.7.0
    mdx-include >=1.4.1,<2.0.0
    mkdocs-redirects>=1.2.1,<1.3.0
    typer == 0.16.0
    pyyaml >=5.3.1,<7.0.0
    # For Material for MkDocs, Chinese search
    jieba==0.42.1
    # For image processing by Material for MkDocs
    pillow==11.3.0
    # For image processing by Material for MkDocs
    cairosvg==2.8.2
    mkdocstrings[python]==0.30.1
    griffe-typingdoc==0.3.0
    griffe-warnings-deprecated==1.1.0
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 14:39:10 GMT 2025
    - 554 bytes
    - Click Count (0)
  4. scripts/docs.py

        post_content = content[post_start:]
        new_content = pre_content + message + post_content
        # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
        new_content = re.sub(
            r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
            "",
            new_content,
            flags=re.DOTALL,
        )
        return new_content
    
    
    @app.command()
    def generate_readme() -> None:
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sun Dec 21 17:40:17 GMT 2025
    - 16.9K bytes
    - Click Count (0)
  5. docs/en/docs/contributing.md

    $ python ./scripts/docs.py new-lang la
    
    Successfully initialized: docs/la
    ```
    
    </div>
    
    Now you can check in your code editor the newly created directory `docs/la/`.
    
    That command created a file `docs/la/mkdocs.yml` with a simple config that inherits everything from the `en` version:
    
    ```yaml
    INHERIT: ../en/mkdocs.yml
    ```
    
    /// tip
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sun Sep 21 11:29:04 GMT 2025
    - 15.1K bytes
    - Click Count (0)
  6. .github/workflows/docs.yml

          - uses: actions/setup-python@v6
            with:
              python-version: 3.x
    
          - run: pip install mkdocs-material mkdocs-redirects
    
          - name: Generate Docs
            run: ./test_docs.sh
    
          - uses: actions/upload-artifact@v6
            with:
              name: docs
    Created: Fri Dec 26 11:42:13 GMT 2025
    - Last Modified: Fri Dec 12 23:30:30 GMT 2025
    - 987 bytes
    - Click Count (0)
  7. .github/workflows/build-docs.yml

          id: filter
          with:
            filters: |
              docs:
                - README.md
                - docs/**
                - docs_src/**
                - requirements-docs.txt
                - pyproject.toml
                - mkdocs.yml
                - mkdocs.env.yml
                - .github/workflows/build-docs.yml
                - .github/workflows/deploy-docs.yml
                - scripts/mkdocs_hooks.py
      langs:
        needs:
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sun Dec 21 17:40:17 GMT 2025
    - 3.3K bytes
    - Click Count (0)
  8. scripts/mkdocs_hooks.py

    from functools import lru_cache
    from pathlib import Path
    from typing import Any, Union
    
    import material
    from mkdocs.config.defaults import MkDocsConfig
    from mkdocs.structure.files import File, Files
    from mkdocs.structure.nav import Link, Navigation, Section
    from mkdocs.structure.pages import Page
    
    non_translated_sections = [
        "reference/",
        "release-notes.md",
        "fastapi-people.md",
        "external-links.md",
        "newsletter.md",
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 21:25:59 GMT 2025
    - 5.6K bytes
    - Click Count (0)
  9. docs/en/docs/management-tasks.md

    When there's a first translation for a language, it will have a `docs/{lang code}/docs/index.md` translated file and a `docs/{lang code}/mkdocs.yml`.
    
    For example, for Bosnian, it would be:
    
    * `docs/bs/docs/index.md`
    * `docs/bs/mkdocs.yml`
    
    The `mkdocs.yml` file will have only the following content:
    
    ```YAML
    INHERIT: ../en/mkdocs.yml
    ```
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Wed Dec 17 20:41:43 GMT 2025
    - 14.2K bytes
    - Click Count (0)
  10. .gitignore

    release.properties
    local.properties
    
    .vscode
    
    .idea
    *.iml
    *.ipr
    *.iws
    *.log
    classes
    
    obj
    
    .DS_Store
    
    # Special Mkdocs files
    docs/4.x
    docs/changelog.md
    docs/contributing.md
    docs/index.md
    
    # jenv
    /.java-version
    /site/
    Created: Fri Dec 26 11:42:13 GMT 2025
    - Last Modified: Sat Oct 11 09:17:37 GMT 2025
    - 354 bytes
    - Click Count (0)
Back to Top