Add website #134

richarddushime · 2025-03-03T01:30:23Z

Before submitting a pull request (PR), please read the contributing guide.

Please fill out as much of this template as you can, but if you have any problems or questions, just leave a comment and we will help out :)

Description

What is this PR
Improving the documentation of cookie-cutter using sphnix

Bug fix
Addition of a new feature
Other

Why is this PR needed?

What does this PR do?

References

#58

How has this PR been tested?

I tested this by Running locally and made sure all is working as Expected.

Is this a breaking change?

No

If this PR breaks any existing functionality, please explain how and why.

Does this PR require an update to the documentation?

yes

If any features have changed, or have been added. Please explain how the
documentation has been updated.

Inprogresss

Checklist:

The code has been tested locally
Tests have been added to cover all new functionality
The documentation has been updated to reflect any changes
The code has been formatted with pre-commit

richarddushime · 2025-03-03T01:33:10Z

Ready for Review

adamltyson · 2025-03-03T13:19:24Z

Looking nice, thanks @richarddushime

adamltyson

This is looking good, thanks @richarddushime. I've left some comments, but at this stage a few high-level comments:

Could you use the same theme and tooling etc as that is inside the cookiecutter template? One of the main aims of this documentation site is to show potential users what their own docs would look like.
Could you use markdown rather than rst? In all our other websites we use md, so this will help maintainance considerably

A few small things:

Could you remove the "give us a star" button?
On my browser at least, the search bar looks a bit weird, like a box in a box in a box!
There seems to be links to an unrelated datascience cookiecutter project

docs/source/index.rst

richarddushime · 2025-03-04T20:00:58Z

This is looking good, thanks @richarddushime. I've left some comments, but at this stage a few high-level comments:

Could you use the same theme and tooling etc as that is inside the cookiecutter template? One of the main aims of this documentation site is to show potential users what their own docs would look like.

Could you use markdown rather than rst? In all our other websites we use md, so this will help maintainance considerably

A few small things:

Could you remove the "give us a star" button?

On my browser at least, the search bar looks a bit weird, like a box in a box in a box!

There seems to be links to an unrelated datascience cookiecutter project

I am Sorry , I actually made a confusion with the cookier-cutter datascience In my mind I thought it was the same as this and I had to link back to it

I will fix this ASAP

Co-authored-by: Adam Tyson <code@adamltyson.com>

richarddushime · 2025-03-05T17:58:20Z

Hi @adamltyson
I have made the changes , I will be waiting for the feedback .
Thanks

adamltyson

This is looking nice, thanks @richarddushime. I've left a couple of suggestions.

Currently it's still a linear list of information, I wonder if there are ways to make it easier to navigate and maybe look nice too? The movement website is a nice example:
https://movement.neuroinformatics.dev/

docs/source/conf.py

docs/source/index.md

richarddushime · 2025-03-06T21:21:54Z

Hi @adamltyson

I worked on the layout based on the requested changes you made,
noting that based on what we have, I separated the navbar and sidebar,

Note> The navbar can also be removed if there is not much things to put there

For the link back to the main site, I included a logo in the footer section

I also did not add the version to the navbar with the project title, like it is done on the Movement website
if it's needed let me know if I should use setuptools_scm or set a static value

Thanks Attached is the screenshot

adamltyson

Thanks @richarddushime, this is looking much better. I've left quite a few comments, but they're mostly very minor. I haven't checked all the content, but that's on us to keep up to date.

One more thing, would you be able to reduce the readme to the bear minimum? Idealy we would only maintain the docs in one place (which will soon become this website).

.github/workflows/cookiecutter_docs.yml

docs/source/conf.py

docs/source/index.md

docs/source/conf.py

docs/source/project_setup.md

docs/source/modules.md

docs/source/versioning.md

docs/source/contributing.md

Co-authored-by: Adam Tyson <code@adamltyson.com>

for more information, see https://pre-commit.ci

Co-authored-by: Adam Tyson <code@adamltyson.com>

richarddushime · 2025-03-10T22:41:42Z

Very nearly there, thanks for your patience @richarddushime. Just two small requests.

Thanks
I m verry sorry I missed it out

Additionnaly
is the logo for NIU needed on the navbar ?? can we maintain only the tool name ?? like Python-cookiecutter v0.1.0 only

adamltyson

I think this is basically done now. I've suggested a few small changes, but we will go through the content ourselves later on and edit.

Re the navbar, ideally the logo would stay. I only say this because there are lots of cookiecutter templats for Python. This isn't intended to be the main one. It's eseentially an internal template that we share with others.

To simplify the navbar, we could probably just get rid of the version number. We don't version this template properly anyway.

Lastly, could you look into why the CI is failing?

docs/source/index.md

docs/source/contributing.md

Co-authored-by: Adam Tyson <code@adamltyson.com>

richarddushime · 2025-03-11T17:50:38Z

Thank you very Much
I have made the last commit
I looked through the CI and Updated accordingly to use NIU actions repository

Hope this time it will pass

About Pre-commit , Locally its passing well , not sure why its now refusing to pass

adamltyson · 2025-03-12T13:45:13Z

Thanks @richarddushime. I will take a look as soon as I can. I've updated the PR title again, would you mind not changing it back?

adamltyson · 2025-03-12T13:47:30Z

Hi @richarddushime it looks like the CI is still not passing. One of the issues is with the linkcheck. You may need to double check the links, and any that are still reporting issues (even though you've manually verified them), may need to be ignored For an example, see the BrainGlobe docs:

https://github.com/brainglobe/brainglobe.github.io/blob/17e1462fbe50aab317cd9ab550af4b7be4ebcb8b/docs/source/conf.py#L189-L196

richarddushime · 2025-03-12T14:24:22Z

Thanks @richarddushime. I will take a look as soon as I can. I've updated the PR title again, would you mind not changing it back?

Sure, I actually had not realised that you renamed it and I thought I was in a wrong PR

richarddushime · 2025-03-12T15:33:51Z

I am not sure why this is persisting but locally All looks well

for more information, see https://pre-commit.ci

adamltyson · 2025-03-12T15:42:17Z

I think there was an issue with a change in main failing the linting. Have updated.

richarddushime · 2025-03-12T15:51:16Z

I think there was an issue with a change in main failing the linting. Have updated.

Finaly I was now going line per line and viewing even the NIU actions repo

👍 Thank you

adamltyson

Looks good, thanks again @richarddushime!

adamltyson · 2025-03-12T17:08:33Z

The actions seem to be running properly, but they aren't creating the gh-pages branch as they should, and so the website isn't deployed.

richarddushime · 2025-03-12T17:51:05Z

The actions seem to be running properly, but they aren't creating the gh-pages branch as they should, and so the website isn't deployed.

let me look into this
Thanks

adamltyson · 2025-03-12T18:25:26Z

Don't worry, I sorted it on our side. Website is live 🎉 https://python-cookiecutter.neuroinformatics.dev/

richarddushime · 2025-03-12T20:36:56Z

The actions seem to be running properly, but they aren't creating the gh-pages branch as they should, and so the website isn't deployed.

Amazing
Thank you

richarddushime added 2 commits March 3, 2025 02:07

Improve doc content neuroinformatics-unit#58

d3c74f6

Github repos creation

f882987

adamltyson linked an issue Mar 3, 2025 that may be closed by this pull request

Improve doc content #58

Closed

5 tasks

adamltyson self-requested a review March 3, 2025 13:19

Fix pre-commit issues

c20945b

richarddushime marked this pull request as ready for review March 3, 2025 21:58

adamltyson reviewed Mar 4, 2025

View reviewed changes

docs/source/index.rst Outdated Show resolved Hide resolved

docs/source/index.rst Outdated Show resolved Hide resolved

docs/source/index.rst Outdated Show resolved Hide resolved

richarddushime and others added 3 commits March 5, 2025 13:36

title update

acecc88

Co-authored-by: Adam Tyson <code@adamltyson.com>

description

43f7a9c

Co-authored-by: Adam Tyson <code@adamltyson.com>

Fix Requested Changes

5279ba8

adamltyson requested changes Mar 6, 2025

View reviewed changes

docs/source/conf.py Show resolved Hide resolved

docs/source/index.md Outdated Show resolved Hide resolved

improved layout

b82c0a0

adamltyson requested changes Mar 7, 2025

View reviewed changes

richarddushime and others added 12 commits March 7, 2025 16:09

Update .github/workflows/cookiecutter_docs.yml

dc847e8

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/conf.py

2fac121

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/conf.py

7708016

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/index.md

bbad1ee

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/project_setup.md

bbfa393

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/project_setup.md

ccb30f4

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/contributing.md

13cdc82

Co-authored-by: Adam Tyson <code@adamltyson.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

3d7ec7a

for more information, see https://pre-commit.ci

Update docs/source/contributing.md

067a818

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/contributing.md

d9d5efb

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/contributing.md

a860e1a

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/get_started.md

1db8ebd

Co-authored-by: Adam Tyson <code@adamltyson.com>

Minor Fixes

eded354

adamltyson requested changes Mar 11, 2025

View reviewed changes

docs/source/index.md Outdated Show resolved Hide resolved

docs/source/index.md Outdated Show resolved Hide resolved

docs/source/index.md Outdated Show resolved Hide resolved

docs/source/contributing.md Outdated Show resolved Hide resolved

adamltyson changed the title ~~Improve doc content #58~~ Add website Mar 11, 2025

richarddushime and others added 5 commits March 11, 2025 18:19

Update docs/source/index.md

4a2d475

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/index.md

e82601c

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/index.md

01b656a

Co-authored-by: Adam Tyson <code@adamltyson.com>

Update docs/source/contributing.md

56a7686

Co-authored-by: Adam Tyson <code@adamltyson.com>

Final

8575e62

richarddushime changed the title ~~Add website~~ Improve doc content Mar 11, 2025

adamltyson changed the title ~~Improve doc content~~ Add website Mar 12, 2025

richarddushime added 2 commits March 12, 2025 16:09

lints errors fix

0717d5d

lints fix

92ccf06

adamltyson and others added 2 commits March 12, 2025 15:39

Merge branch 'main' into sphnix-docs

44323ff

[pre-commit.ci] auto fixes from pre-commit.com hooks

865fff7

for more information, see https://pre-commit.ci

adamltyson self-requested a review March 12, 2025 17:01

adamltyson approved these changes Mar 12, 2025

View reviewed changes

adamltyson merged commit ebd13de into neuroinformatics-unit:main Mar 12, 2025
10 checks passed

adamltyson mentioned this pull request Jun 3, 2025

Create docs site #36

Closed

Add website #134

Add website #134

Uh oh!

Conversation

richarddushime commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

References

How has this PR been tested?

Is this a breaking change?

Does this PR require an update to the documentation?

Checklist:

Uh oh!

richarddushime commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adamltyson commented Mar 3, 2025

Uh oh!

adamltyson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richarddushime commented Mar 4, 2025

Uh oh!

richarddushime commented Mar 5, 2025

Uh oh!

adamltyson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

richarddushime commented Mar 6, 2025

Uh oh!

adamltyson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richarddushime commented Mar 10, 2025

Uh oh!

adamltyson left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richarddushime commented Mar 11, 2025

Uh oh!

adamltyson commented Mar 12, 2025

Uh oh!

adamltyson commented Mar 12, 2025

Uh oh!

richarddushime commented Mar 12, 2025

Uh oh!

richarddushime commented Mar 12, 2025

Uh oh!

adamltyson commented Mar 12, 2025

Uh oh!

richarddushime commented Mar 12, 2025

Uh oh!

adamltyson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adamltyson commented Mar 12, 2025

Uh oh!

richarddushime commented Mar 12, 2025

Uh oh!

richarddushime commented Mar 3, 2025 •

edited

Loading

richarddushime commented Mar 3, 2025 •

edited

Loading

adamltyson left a comment •

edited

Loading