Coder Social home page Coder Social logo

ain-soph / trojanzoo_sphinx_theme Goto Github PK

View Code? Open in Web Editor NEW
5.0 5.0 2.0 4.05 MB

The sphinx theme for trojanzoo, modified from pytorch_sphinx_theme

Home Page: https://ain-soph.github.io/trojanzoo_sphinx_theme/

License: GNU General Public License v3.0

JavaScript 12.16% Python 1.16% HTML 7.13% CSS 79.55%

trojanzoo_sphinx_theme's People

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

trojanzoo_sphinx_theme's Issues

Control over Page Width and Shortcut items

Thank you for the amazing template. I am stuck on two things and was hoping you could point me in the right direction:

  1. I would like to adjust the page with of the documentation page to make it wider, ideally have control over the size of the left menu bar, the documentation body in the middle, as well as the "shortcuts" on the right. I have played with various custom css div targets, to set max-width, however, they seem to be restricted somewhere, so that setting these parameters does not change the layout.
  2. In my project the shortcut items do show up but with "Shortcut" above and they move of the page when scrolling down, how can I set those items to stay on the page, even when scrolling?

Follow

Hello, I'd like to try to do the work that you have done.I just want to removed all Pytorch related stuff of the pytorch_sphinx_theme. I also want to removes all other unnecessary items, making it a pure Doc template to edit my own docs. Do you have instructions for the relevant change process? Or how can I follow your project to build my own documentation, what changes do I need to make?

Confuse of adding different documents to the Docs's dropdowm button

I've looked at your documentation demos and it seems that you are adding their links to the dropdowm button in Docs via the unified url naming in GitHub Pages.

https://ain-soph.github.io/trojanzoo_sphinx_theme/
https://ain-soph.github.io/alpsplot/
https://ain-soph.github.io/trojanzoo/

What I'm wondering is whether these documents need to be built separately first into .html files (perhaps done by GitHub Pages).

Because each document has its own conf.py and layout.html. Can I think that they are actually different pages, when clicking on trojanzoo or trojanzoo_sphinx_theme, the pages are built by different conf.py and layout.html etc. Just because it is hosted by GitHub Pages and has a unified url naming format, you can include them on the same page by adjusting github_user and github_repo.

For example, when I use sphinx-autobuild to build Doc A and Doc B on the host loopback address, they are on port 8000 and 8001 of host127.0.0.1. When I include Doc B in the Docs Dropdown of the Doc A page, clicking on Doc B should jump to port 8001.

Since I'm relatively new to network-related processes, my description is confusing. I hope you can reply me whether my understanding is correct, if wrong, what should be the correct principle.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.