Skip to content

Docs: Add initial documentation#10

Merged
izzet merged 5 commits intollnl:mainfrom
izzet:fix/project-docs
Jul 10, 2025
Merged

Docs: Add initial documentation#10
izzet merged 5 commits intollnl:mainfrom
izzet:fix/project-docs

Conversation

@izzet
Copy link
Collaborator

@izzet izzet commented Jul 10, 2025

This pull request introduces significant updates to the DFAnalyzer project, focusing on documentation enhancements, configuration improvements, and codebase adjustments. The changes include the addition of Sphinx-based documentation, updates to configuration parameters, and a new README with detailed installation and usage instructions.

Documentation Enhancements:

  • Added a Sphinx configuration file (docs/conf.py) and a minimal Makefile for building documentation, enabling the use of the Read the Docs platform. [1] [2]
  • Created a detailed configuration.rst file documenting all configuration parameters, analyzers, output options, and cluster configurations.
  • Introduced a .readthedocs.yaml file to define the Read the Docs build environment, specifying Python 3.12 and Sphinx settings.

Configuration Updates:

  • Updated the default checkpoint directory in AnalyzerConfig from ${hydra:runtime.output_dir} to ${hydra:run.dir} for consistency with Hydra's runtime directory structure.
  • Removed the default value for time_granularity in the Config class, making it optional.

README Overhaul:

  • Replaced the placeholder README with a comprehensive guide, including an overview of DFAnalyzer, installation instructions, usage examples, and links to resources such as documentation and contribution guidelines.

@izzet izzet merged commit e10ae48 into llnl:main Jul 10, 2025
0 of 3 checks passed
@izzet izzet deleted the fix/project-docs branch July 10, 2025 00:59
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.

1 participant