Documentation clean up (aimclub#189)

* replace nss with aimclub * fix links
SoloWayG · Sep 13, 2023 · 0586523 · 0586523
1 parent a5c4e56
commit 0586523
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 17 deletions.
diff --git a/README.rst b/README.rst
@@ -57,7 +57,7 @@ GOLEM потенциально применим к любой структуре
 Примеры применения GOLEM:
 
 - Автоматическое машинное обучение (AutoML) для поиска оптимальных пайплайнов машинного обучения в `фреймворке FEDOT <https://github.com/aimclub/FEDOT>`_
-- Поиск структуры при помощи байесовской сети в `фреймворке BAMT <https://github.com/ITMO-NSS-team/BAMT>`_
+- Поиск структуры при помощи байесовской сети в `фреймворке BAMT <https://github.com/aimclub/BAMT>`_
 - Поиск дифференциальных уравнений для физических моделей в рамках `фреймворка EPDE <https://github.com/ITMO-NSS-team/EPDE>`_
 - Геометрический дизайн физических объектов в рамках `фреймворка GEFEST <https://github.com/aimclub/GEFEST>`_
 - `Поиск архитектуры нейронных сетей <https://github.com/ITMO-NSS-team/nas-fedot>`_
@@ -226,11 +226,11 @@ GOLEM можно установить с помощью ``pip``:
 .. |eng| image:: https://img.shields.io/badge/lang-en-red.svg
             :target: /README_en.rst
 
-.. |ITMO| image:: https://github.com/ITMO-NSS-team/open-source-ops/blob/add_badge/badges/ITMO_badge_rus.svg
+.. |ITMO| image:: https://github.com/aimclub/open-source-ops/blob/add_badge/badges/ITMO_badge_rus.svg
    :alt: Acknowledgement to ITMO
    :target: https://itmo.ru
 
-.. |SAI| image:: https://github.com/ITMO-NSS-team/open-source-ops/blob/add_badge/badges/SAI_badge.svg
+.. |SAI| image:: https://github.com/aimclub/open-source-ops/blob/add_badge/badges/SAI_badge.svg
    :alt: Acknowledgement to SAI
    :target: https://sai.itmo.ru/
 

diff --git a/README_en.rst b/README_en.rst
@@ -56,7 +56,7 @@ define a data-flow or inference process (e.g. bayesian networks that can be fitt
 Examples of GOLEM applications:
 
 - Automatic Machine Learning (AutoML) with optimal ML pipelines search in `FEDOT framework <https://github.com/aimclub/FEDOT>`_
-- Bayesian network structure search in `BAMT framework <https://github.com/ITMO-NSS-team/BAMT>`_
+- Bayesian network structure search in `BAMT framework <https://github.com/aimclub/BAMT>`_
 - Differential equation discovery for physical models in `EPDE framework <https://github.com/ITMO-NSS-team/EPDE>`_
 - Geometric design of physical objects in `GEFEST framework <https://github.com/aimclub/GEFEST>`_
 - `Neural architecture search <https://github.com/ITMO-NSS-team/nas-fedot>`_
@@ -225,11 +225,11 @@ There are various cases solved with GOLEM's algorithms:
 .. |rus| image:: https://img.shields.io/badge/lang-ru-yellow.svg
             :target: /README.rst
 
-.. |ITMO| image:: https://github.com/ITMO-NSS-team/open-source-ops/blob/add_badge/badges/ITMO_badge.svg
+.. |ITMO| image:: https://github.com/aimclub/open-source-ops/blob/add_badge/badges/ITMO_badge.svg
    :alt: Acknowledgement to ITMO
    :target: https://en.itmo.ru/en/
 
-.. |SAI| image:: https://github.com/ITMO-NSS-team/open-source-ops/blob/add_badge/badges/SAI_badge.svg
+.. |SAI| image:: https://github.com/aimclub/open-source-ops/blob/add_badge/badges/SAI_badge.svg
    :alt: Acknowledgement to SAI
    :target: https://sai.itmo.ru/
 

diff --git a/docs/source/contribution.rst b/docs/source/contribution.rst
@@ -2,10 +2,10 @@ Contribution
 ============
 
 We welcome you to `check the existing
-issues <https://github.com/ITMO-NSS-team/GOLEM/issues>`__ for bugs or
+issues <https://github.com/aimclub/GOLEM/issues>`__ for bugs or
 enhancements to work on. If you have an idea for an extension to GOLEM,
 please `file a new
-issue <https://github.com/ITMO-NSS-team/GOLEM/issues/new>`__ so we can
+issue <https://github.com/aimclub/GOLEM/issues/new>`__ so we can
 discuss it.
 
 Make sure to familiarize yourself with the project layout before making
@@ -16,9 +16,9 @@ How to contribute
 -----------------
 
 The preferred way to contribute to GOLEM is to fork the `main
-repository <https://github.com/ITMO-NSS-team/GOLEM/>`__ on GitHub:
+repository <https://github.com/aimclub/GOLEM/>`__ on GitHub:
 
-1. Fork the `project repository <https://github.com/ITMO-NSS-team/GOLEM>`__:
+1. Fork the `project repository <https://github.com/aimclub/GOLEM>`__:
    click on the 'Fork' button near the top of the page. This creates a
    copy of the code under your account on the GitHub server.
 
@@ -84,17 +84,17 @@ necessary so we can efficiently review and accept your changes.
 If your contribution changes GOLEM in any way:
 
 -  Update the
-   `documentation <https://github.com/ITMO-NSS-team/GOLEM/tree/main/docs>`__
+   `documentation <https://github.com/aimclub/GOLEM/tree/main/docs>`__
    so all of your changes are reflected there.
 
 -  Update the
-   `README <https://github.com/ITMO-NSS-team/GOLEM/blob/main/README.rst>`__
+   `README <https://github.com/aimclub/GOLEM/blob/main/README.rst>`__
    if anything there has changed.
 
 If your contribution involves any code changes:
 
 -  Update the `project unit
-   tests <https://github.com/ITMO-NSS-team/GOLEM/tree/main/test>`__ to
+   tests <https://github.com/aimclub/GOLEM/tree/main/test>`__ to
    test your code changes.
 
 -  Make sure that your code is properly commented with
@@ -110,7 +110,7 @@ If your contribution requires a new library dependency:
    changes because we want to keep GOLEM easy to install.
 
 -  Add the required version of the library to
-   `requirements.txt <https://github.com/ITMO-NSS-team/GOLEM/blob/main/requirements.txt>`__
+   `requirements.txt <https://github.com/aimclub/GOLEM/blob/main/requirements.txt>`__
 
 Contribute to the documentation
 -------------------------------
@@ -121,7 +121,7 @@ automodule:: <module_name> section which describes all the code in the module.
 
 -  If a new package with several scripts:
 
-   1. Go to `docs/source/GOLEM <https://github.com/ITMO-NSS-team/GOLEM/tree/main/docs/source/GOLEM>`__ and create new your_name_for_file.rst file.
+   1. Go to `docs/source/GOLEM <https://github.com/aimclub/GOLEM/tree/main/docs/source/GOLEM>`__ and create new your_name_for_file.rst file.
 
    2. Add a Header underlined with “=” sign. It’s crucial.
 
@@ -143,7 +143,7 @@ automodule:: <module_name> section which describes all the code in the module.
 
 -  If a new module to the existed package:
 
-    Most of the sections are already described in `docs/source/api <https://github.com/ITMO-NSS-team/GOLEM/tree/main/docs/source/api>`__ , so you can:
+    Most of the sections are already described in `docs/source/api <https://github.com/aimclub/GOLEM/tree/main/docs/source/api>`__ , so you can:
 
    -  choose the most appropriate and repeat 3-d step from the previous section.
    -  or create a new one and repeat 2-3 steps from the previous section.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,7 +4,7 @@ Welcome to GOLEM's documentation!
 .. container::
 
    | |logo|
-   | There is contained main documentation for the `GOLEM framework <https://github.com/ITMO-NSS-team/GOLEM>`__.
+   | There is contained main documentation for the `GOLEM framework <https://github.com/aimclub/GOLEM>`__.
    |
    | **GOLEM**: Graph Optimization and Learning by Evolutionary Methods