Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.29 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.29 KB
Raw

Taipy Doc

License

Copyright 2021-2024 Avaiga Private Limited

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Usage

What is Taipy Doc

Taipy is a Python library for creating Business Applications. More information on our website. Taipy is split into multiple repositories to let users install the minimum they need.

Taipy Doc has the responsibility to hold and build the full Taipy documentation set. The taipy-doc repository uses MkDocs to generate its entire content.

Installation

Want to install Taipy Doc? Check out our INSTALLATION.md file.

Contributing

Want to help build Taipy Doc? Check out our CONTRIBUTING.md file.

Code of conduct

Want to be part of the Taipy Doc community? Check out our CODE_OF_CONDUCT.md file.

Directory Structure

  • docs: Documentation content (mainly as Markdown files) used by mkdocs to generate the Taipy documentation set.
  • tools: Mkdocs and other tools used to build the Taipy documentation set.
  • CODE_OF_CONDUCT.md: Code of conduct for members and contributors of taipy-doc.
  • CONTRIBUTING.md: Instructions to contribute to taipy-doc.
  • INSTALLATION.md: Instructions to install taipy-doc.
  • LICENSE: The Apache 2.0 License.
  • Pipfile: File used by the Pipenv virtual environment to manage project dependencies.
  • README.md: Current file.
  • mkdocs.yml_template: The template used by mkdocs and other tools to build the Taipy documentation set.