docs: Restructure documentation to reflect package decomposition into subpackages and methods#106
Draft
docs: Restructure documentation to reflect package decomposition into subpackages and methods#106
Conversation
…kages and methods Co-authored-by: corentinravoux <52483673+corentinravoux@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for decomposed package and methods
docs: Restructure documentation to reflect package decomposition into subpackages and methods
Mar 18, 2026
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.
The package has been decomposed into common modules (
power_spectra,data_vector,data) and distinct method subpackages (covariance, simulation, field comparison), but the docs still reflected the old monolithic structure.New pages
overview.rst— Package structure overview: common modules vs. method subpackagescovariance_method.rst— Likelihood-based field-level inference method (arXiv:2501.16852), analytical models, usage workflowsimulation.rst— Forward modeling simulation (under construction)field_comparison.rst— Field comparison method (not yet implemented)Updated pages
index.rst— Three toctree sections: "Getting started", "Common modules", "Methods"conf.py—autoapi_dirsextended to cover all subpackages (data_vector,power_spectra,data,simulation)power_spectra.rst— Broken markdown fences → proper RSTcode-blockdirectives; added engine/model docslikelihoods.rst— Fixed malformed LaTeX (backtick-wrapped math blocks); added inversion methods section; linked to covariance methodDataVector.rst— Contextualized as a shared moduleWarning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
docs.astropy.org/usr/bin/python python -m sphinx -b html . _build/html(dns block)docs.python.org/usr/bin/python python -m sphinx -b html . _build/html(dns block)docs.scipy.org/usr/bin/python python -m sphinx -b html . _build/html(dns block)pandas.pydata.org/usr/bin/python python -m sphinx -b html . _build/html(dns block)sncosmo.readthedocs.io/usr/bin/python python -m sphinx -b html . _build/html(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.