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

fix read the docs #10

Merged
merged 10 commits into from
Feb 24, 2023
Merged

fix read the docs #10

merged 10 commits into from
Feb 24, 2023

Conversation

ahms5
Copy link
Member

@ahms5 ahms5 commented Feb 7, 2023

appied doc style from pyfar

@ahms5 ahms5 self-assigned this Feb 7, 2023
@ahms5 ahms5 added the documentation Improvements or additions to documentation label Feb 7, 2023
@ahms5 ahms5 mentioned this pull request Feb 13, 2023
@ahms5 ahms5 mentioned this pull request Feb 23, 2023
@ahms5 ahms5 marked this pull request as ready for review February 23, 2023 17:54
Comment on lines 1 to 11
Concepts
========

The sections below give background information that is helpful to fully
understand how pyfar works and to understand how to work with pyfar. If you
are new to pyfar and or acoustics signal processing, we recommend briefly going
through these concepts.

.. toctree::
:maxdepth: 1

Copy link
Member

Choose a reason for hiding this comment

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

Imkar does not really need these concepts yet, please delete

docs/conf.py Outdated
@@ -153,10 +174,7 @@
(master_doc, 'imkar',
'imkar Documentation',
author,
'imkar',
'pyfar',
Copy link
Member

Choose a reason for hiding this comment

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

?

docs/index.rst Outdated
.. toctree::
:maxdepth: 2

concepts
Copy link
Member

Choose a reason for hiding this comment

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

please remove

docs/index.rst Outdated
Comment on lines 1 to 5
.. |imkar_logo| image:: resources/imkar.png
:width: 150
:alt: Alternative text

|imkar_logo|
Copy link
Member

Choose a reason for hiding this comment

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

There's no imkar logo yet, so please remove.
Also remove the pyfar logo.

@mberz mberz self-requested a review February 24, 2023 14:27
@mberz mberz merged commit 00413c0 into develop Feb 24, 2023
@mberz mberz deleted the readdocs branch February 24, 2023 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants