Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small documentation fixes #1715

Merged
merged 19 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Since last release
* Resolved various compilation warnings due to use of deprecated APIs (#1671)
* Update version management in CMake build (#1696)
* Changed dependency versions in README.rst, INSTALL.rst, and DEPENDENCIES.rst (#1703)
* Updated minor documentation about updating CHANGELOG.rst, fix formatting for rendering
hyperlinks, and change branch name in README instructions on forking for development (#1715)

**Removed:**

Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ General Notes
Issuing a Pull Request
======================

* Please make sure you describe the changes you made to the code in the
`CHANGELOG <CHANGELOG.rst>`_.

* When you are ready to move changes from one of your topic branches into the
"main" branch, it must be reviewed and accepted by another developer.

Expand Down
19 changes: 10 additions & 9 deletions INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ provided with the source.
Dependencies
************

A full list of the Cyclus package dependencies is listed :doc:`here <DEPENDENCIES>`:
A full list of the Cyclus package dependencies is listed `here`_.
bennibbelink marked this conversation as resolved.
Show resolved Hide resolved

************
Installation
Expand All @@ -21,8 +21,7 @@ Installation

Before going further with the installation procedure be sure you have installed
all the required dependencies. We have provided detailed
instructions for :doc:`installing dependencies <DEPENDENCIES>` for the major supported
systems.
instructions `for installing those dependencies for the major supported systems`_.


Default Installation
Expand Down Expand Up @@ -52,6 +51,13 @@ On MacOSX you also need to add ~/.local/lib/pythonX.Y/site-packages to your
print(".".join(map(str, sys.version_info[:2])))'`/site-packages:\$PYTHONPATH\"" >> ~/.bashrc
source ~/.bashrc


.. _`Cyclus Homepage`: http://fuelcycle.org/
.. _`Cyclus User Guide`: http://fuelcycle.org/user/index.html
.. _`Cyclus repo`: https://github.com/cyclus/cyclus
.. _`Cycamore Repo`: https://github.com/cyclus/cycamore
.. _`for installing those dependencies for the major supported systems`: https://fuelcycle.org/user/DEPENDENCIES.html
.. _`here`: https://fuelcycle.org/user/DEPENDENCIES.html
.. website_include_end

.. website_custom_start
Expand Down Expand Up @@ -174,7 +180,7 @@ dependencies through conda-forge.
.. code-block:: bash

conda config --add channels conda-forge
conda install cyclus-build-deps
conda install cyclus --only-deps


*************
Expand All @@ -191,8 +197,3 @@ proper functioning of Cyclus. You can run the tests yourself via:
$ cyclus_unit_tests


.. _`Cyclus Homepage`: http://fuelcycle.org/
.. _`Cyclus User Guide`: http://fuelcycle.org/user/index.html
.. _`Cyclus repo`: https://github.com/cyclus/cyclus
.. _`Cycamore Repo`: https://github.com/cyclus/cycamore
.. _`for installing those dependencies for the major supported systems`: DEPENDENCIES.rst
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,11 @@ to contribute into Cyclus, please follow this procedure:

#. Fork Cyclus repository,

#. Create a working branch on your fork from the ``develop`` branch,
#. Create a working branch on your fork from the ``main`` branch,

#. Implement your modification of the Cyclus source code,

#. Submit a Pull request into ``Cyclus/develop`` branch,
#. Submit a Pull request into ``Cyclus/main`` branch,

#. Wait for reviews/merge (the proposer of a pull request cannot be the Merger).

Expand Down