Skip to content

Conversation

@ramosv
Copy link
Member

@ramosv ramosv commented Oct 26, 2025

Adding arxiv citations to readthedocs and readme.md

Doing a draft pr as I am still fixing the following warnings from the docs build.

WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]
WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]
WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]

@ramosv ramosv self-assigned this Oct 26, 2025
@ramosv
Copy link
Member Author

ramosv commented Oct 26, 2025

  • Fixed all the warnings on the first PR.
  • Removed unnecessary build files.
  • Added arxiv DOI and modified grammatical mistakes

@ramosv ramosv marked this pull request as ready for review October 26, 2025 22:20
Copilot AI review requested due to automatic review settings October 26, 2025 22:20
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request adds arXiv citation information to both the README.md and documentation (index.rst) to allow users to properly cite BioNeuralNet in their research. The changes also include the addition of sphinx-copybutton extension to improve code snippet usability in the documentation, formatting improvements to dataset descriptions, and code formatting cleanup.

Key Changes:

  • Added arXiv citation sections with BibTeX entries to README.md and docs/source/index.rst
  • Added sphinx-copybutton extension to documentation dependencies and configuration
  • Updated dataset descriptions for consistency and clarity

Reviewed Changes

Copilot reviewed 8 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
requirements-dev.txt Added sphinx-copybutton dependency for development environment
docs/source/index.rst Added Citation section with arXiv paper details and BibTeX entry
docs/source/datasets.ipynb Updated dataset descriptions and section headers for consistency
docs/source/conf.py Added sphinx_copybutton to Sphinx extensions list
docs/requirements.txt Added sphinx-copybutton to documentation build dependencies
docs/jupyter_execute/TCGA-BRCA_Dataset.ipynb Removed entire file (1354 lines deleted)
bioneuralnet/utils/init.py Consolidated all list to single line
README.md Added Citation sections at beginning and end with arXiv paper and BibTeX entries

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ramosv
Copy link
Member Author

ramosv commented Oct 26, 2025

This PR fixes issue/task: #90
Fixed all the warnings on the first PR.
Removed unnecessary build files.
Added arxiv DOI and modified grammatical mistakes

@ramosv
Copy link
Member Author

ramosv commented Oct 26, 2025

Last commit was to address copilots comments. The PR is ready for review:
@SundousHussein @abdelhafizm

@ramosv ramosv merged commit 0552d2b into main Nov 1, 2025
11 checks passed
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.

3 participants