Merged
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
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.
This pull request introduces comprehensive improvements to the documentation and packaging for the
sectionateproject. The changes focus on enhancing installation instructions, updating badges, adding Conda packaging, and establishing a robust Sphinx documentation setup.Documentation and Installation Improvements:
README.mdto feature new badges for PyPI, Conda, documentation, and license, and revised installation instructions to recommend Conda as the default method.docs/source/installation.rstwith detailed requirements and multiple installation methods, including Conda, Pip, and GitHub.docs/source/index.rstto serve as the main entry point for Sphinx documentation, including a table of contents linking to installation and example notebooks.Conda Packaging:
conda/meta.yamlrecipe for packaging, specifying dependencies, build instructions, test commands, and metadata for Conda Forge distribution.ci/environment.ymlto add thenodefaultschannel, ensuring only conda-forge packages are used.Sphinx Documentation Setup:
Makefileand Windows batch file for building documentation, along with a custom responsive CSS for improved layout. [1] [2] [3]docs/source/conf.pywith configuration for project metadata, notebook copying automation, theme customization, and extension setup.docs/environment.ymlto include Sphinx, nbsphinx, ipykernel, and pip for documentation builds.