Comments (8)
from ipyniivue.
Thanks @AnthonyAndroulakis
@scott-huberty is that issue familiar to you? Did you encounter a similar issue when working on the doc for the PyLossless project?
from ipyniivue.
I only took a quick look, but it looks like you are using pydata_sphinx_theme
. The projects I've worked on that use this template, the structure typically looks like this:
project_root
├── docs
| ├── make.bat
│ └── Makefile
| └──build
| └──source
│ | ├── index.rst # this is the documentation main entry point
| | ├── _static
| | └── generated # this is where the built docs are placed by sphinx
| | ├── index.rst
│ ├── conf.py # this is your sphinx configuration file
| ├── examples # where auto sphinx looks for tutorials to build into RST docs
| | ├── my_tutorial.py
It looks like your documentation branch just has a lot of sphinx stuff sitting in the root directory. In principle it could be ipyniivue/doc
where all this stuff can live, and that can eventually get merged to main.
For css I think you can use a custom css file as long as you point sphinx to it, via the conf.py
file.
So if you add a directory css/custom.css
to the _static
directory, the line to add in conf.py would be something like this:
# user made CSS to customize look
html_css_files = [
'css/custom.css',
]
@AnthonyAndroulakis, the pydata_sphinx_theme
project doesn't have the best documentation IMO - so feel free to take a look at https://github.com/lina-usc/pylossless/tree/main , I'm pretty sure I set some custom css there.
For more complex examples you can look at mne-tools/mne-python, or most of the other packages in the mne-tools account. They all use pydata_sphinx_theme
.
from ipyniivue.
Thank you for the information. I'll test out ipyniivue docs with that folder structure.
from ipyniivue.
No problem,
If you get stuck on something feel free to ping me and I'll see if I can take a look or make quick commit
from ipyniivue.
@cdrake Would you mind giving me a screenshot equivalent to this for NiiVue:
I don't have the kind of access to view that, and I expect you do. Just to guide me in how to setup the GitHub pages deployment for IPyNiiVue. It was deactivated (and the deployment workflow was crashing... I am looking into that)
from ipyniivue.
Nevermind @cdrake, I figured it out! It deploys fine now. I'll check the CSS issue now.
from ipyniivue.
This resolved. The fix for the issues with the rendering was actually very silly (just needed to add an empty .nojekyll file at the root of the documentation branch, as per https://stackoverflow.com/a/64544659). I also fixed the deployment issues.
from ipyniivue.
Related Issues (20)
- ipyniivue installting correctly but viewer window not showing up
- a
- Graph features
- Add custom colormaps
- devDependency requirement on @jupyterlab/builder@^4.0.0
- load_meshes HOT 1
- Review code of NiiVue Jupyter notebook integration in IPyNiiVue HOT 4
- load_meshes does not add the mesh to self.meshes in MacOS and Linux HOT 5
- Restarting the kernel fails to destroy the NiiVue object
- jupyterlab 4 support HOT 4
- ENH: Integration with MNE-Python
- Possible to add overlays and/or possibly saving the whole scene as .html file to harddrive?
- Prototype of ipyniivue using anywidget HOT 7
- Project admin, milestones, and roadmap
- Priorities HOT 6
- ☂️ Volume HOT 9
- Better camel/snake scale conversion HOT 10
- Exposing `nv.saveScene` on the python side HOT 1
- Deleting big files HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ipyniivue.