Skip to content

Task/config options doc - #853

Merged
rhornung67 merged 11 commits into
developfrom
task/config-options-doc
Jun 28, 2022
Merged

Task/config options doc#853
rhornung67 merged 11 commits into
developfrom
task/config-options-doc

Conversation

@rhornung67

Copy link
Copy Markdown
Member

Summary

  • This PR expands on discussion of Axom configuration options in the Quickstart guide and attempts to clarify and emphasize key points for users and developers.

The updated documentation can be viewed here: https://axom.readthedocs.io/en/task-config-options-doc/docs/sphinx/quickstart_guide/config_build.html

This should resolve #711

@kennyweiss kennyweiss left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @rhornung67 -- this is a really nice improvement

Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/coding_guide/sec10_dev_macros.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
@rhornung67

Copy link
Copy Markdown
Member Author

@kennyweiss @agcapps @white238 @bmhan12 I believe I addressed all your comments with the latest changes I pushed.

Comment thread src/docs/sphinx/quickstart_guide/config_build.rst
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated

@agcapps agcapps left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @rhornung67 . Much appreciated.

@rhornung67 rhornung67 added this to the March 2022 Release milestone Jun 27, 2022
Comment thread src/CMakeLists.txt
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
Comment thread src/docs/sphinx/quickstart_guide/config_build.rst Outdated
@rhornung67
rhornung67 merged commit 811a142 into develop Jun 28, 2022
@rhornung67
rhornung67 deleted the task/config-options-doc branch June 28, 2022 16:37
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.

Review Axom's config options and associated documentation

6 participants