Docs #5
Merged
Docs #5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refactored the documentation configuration in `conf.py` to use Pathlib for better path management. Updated the logic for copying example files and the CONTRIBUTING.md file to the documentation source directory. Removed the old CONTRIBUTING.rst file as part of this update, streamlining the documentation structure and ensuring all necessary files are correctly referenced. This change enhances maintainability and prepares for future documentation updates.
Eliminated unused commented-out code related to example paths in `conf.py`. This change helps to clean up the documentation configuration file, improving readability and maintainability without affecting functionality.
Changed the assignment of SRC_DIR in `conf.py` to use the parent directory of the current file. This adjustment improves path management and aligns with the updated structure established in previous commits, enhancing maintainability of the documentation configuration.
Included `myst_parser` in the documentation dependencies within `pyproject.toml`. This addition enables support for MyST Markdown, enhancing the documentation capabilities and allowing for more flexible content formatting.
Replaced multiple individual development dependencies with a single entry for `matgraphdb[docs,tests]`. This change simplifies the dependency management in the project and ensures that all necessary packages for documentation and testing are included in one line, improving clarity and maintainability of the configuration.
Moved the tutorials form the docs source to the examples directory. Updated the index.rst file to include links to the new tutorial notebooks, ensuring easy navigation for users seeking to learn about MatGraphDB.
Added pyrightconfig.json to .gitignore to prevent tracking of the configuration file. Removed the existing pyrightconfig.json file as it was no longer needed, streamlining the project structure and ensuring unnecessary files are not included in version control.
Enhanced the README by adding documentation and project links for better navigation. Clarified the relationship with `ParquetGraphDB` and updated references to the CONTRIBUTING and LICENSE files. This improves user experience and accessibility of important resources.
Modified the .gitignore file to ensure the data directory is ignored by adding a wildcard entry for *data/. This change prevents tracking of any files within the data directory, maintaining a cleaner project structure and avoiding unnecessary file inclusion in version control.
Introduced a new Jupyter notebook for building a materials graph database using the MPNearHull dataset. This example demonstrates the process of importing libraries, downloading data, and setting up a MatGraphDB instance. Updated the index.rst files to include links to the new tutorials and applications sections, improving navigation for users seeking to explore MatGraphDB functionalities.
Removed links to the tutorials section in index.rst as they are no longer relevant. This change streamlines the documentation and improves clarity for users navigating the examples of MatGraphDB.
Changed the title in index.rst from "Getting Started" to "MPNearHull Dataset" to accurately represent the content of the example. This update improves navigation and clarity for users exploring the MatGraphDB documentation.
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.