Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation in MkDocs #64

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

JosePizarro3
Copy link
Contributor

@JosePizarro3 JosePizarro3 commented Jan 28, 2025

This pull request includes several changes aimed at improving the documentation, updating dependencies, and cleaning up the repository. The most important changes include removing submodules, updating installation instructions, and enhancing the documentation structure and styling.

Documentation Updates:

  • README.md: Added installation instructions for bam-masterdata using pip and updated the script path for installing Python dependencies. [1] [2]
  • docs/index.md: Updated the welcome message and reorganized the tutorial and how-to guide sections for clarity. [1] [2] [3]
  • docs/tutorials/tutorial.md: Added a new tutorial for installation setup, including instructions for both pip and development installations.

Dependency and Configuration Changes:

Styling and Theming:

Configuration Cleanup:

  • mkdocs.yml: Updated the navigation structure to reflect the new documentation organization and added mkdocstrings plugin for better API documentation. [1] [2] [3]

Script Updates:

@JosePizarro3 JosePizarro3 linked an issue Jan 28, 2025 that may be closed by this pull request
@coveralls
Copy link

Pull Request Test Coverage Report for Build 13012275198

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 95.421%

Totals Coverage Status
Change from base Build 13010915920: 0.0%
Covered Lines: 16400
Relevant Lines: 17187

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation in MkDocs
2 participants