Add top menubar from astropy.org

Having the top menubar for the docs from astropy.org would be super nice, among others, it would definitely enhance the visibility of e.g. the affiliated packages, the team the the need for citation.

#8293 (comment)

Hi - I'd like to take this on as a first issue if no one else has. Might need some guidance though,

@blatted

Hi @blatted! This issue is all yours.
General contributions guide is here: https://astropy.readthedocs.io/en/latest/development/workflow/development_workflow.html though for this issue it's a bit different (e.g. no need to write tests, etc) as it involves changing the sphinx theme.
The task here is to modify the top menubar at http://docs.astropy.org/en/latest/ to get the same options* as over on the main webpage http://www.astropy.org/.

The main repo for the webpage is here: https://github.com/astropy/astropy.github.com.

(* but keep the current "index" and "modules" ones on the right hand side)

@bsipocz

Thanks @bsipocz ! I assume I should fork the sphinx layout repo then and edit this file? :

https://github.com/astropy/astropy-sphinx-theme/blob/master/astropy_sphinx_theme/bootstrap-astropy/layout.html

Yes, you possibly need to also modify the theme, to add this top bar as an option, and then in this repo add the content.

@bsipocz

Thanks @bsipocz , I made changes and am currently trying to preview them before submitting a PR. Having trouble getting it to work, do you know of a good way to quickly preview the webpage?

Once you open a PR, circleCI will test tit and the build will be available through the Giles bot. To reproduce locally I suppose you can follow the command the CI does but I haven't really tried to rebuild the webpage locally, so don't know the pitfalls.

(Oh for the astropy docs, it's detailed in the developer documentation how to do it locally:
python setup.py build_docs at the bottom of this page: http://docs.astropy.org/en/latest/development/docguide.html)

@bsipocz

Hey Hi @bsipocz . Is this issue resolved, if not, then I think I can do this. Can you help me with what should I put in menu bar. I want to get started with astropy. But I am not much familiar with it. Till I get some documentation, I could help with the website problem.

@sunn-e

Hey @sunn-e! This hasn't been solved, and the whole idea is detailed out above in #8320 (comment)

@bsipocz

Hey @bsipocz , I tried a lot and nav bar still breaks. Also, I have a doubt, do I need to modify the main webpage's menubar or the documentation page's menubar? Because in the later scenario, I can't find the html file related to the documentations pages in github repo. Can you please confirm whether they are in the main website's repo or somewhere else. Thanks a lot.

@bsipocz

Hi @bsipocz, can I try this issue if no one has solved it? (I can wait until the time is right.) Actually I really wanted to try this since a couple weeks ago, but someone else was working on it previously so I hesitated. I feel I really would learn a lot from the experience, since I have not done so (professionally) before...

@kakirastern

@kakirastern - go for it, so far no one came up with a draft PR so it's more than fair game to give it a go.

@bsipocz

Thanks @bsipocz! I will give it a try right away...

@bsipocz

Yes, you possibly need to also modify the theme, to add this top bar as an option, and then in this repo add the content.

@bsipocz Regarding the "content" item referenced above in a previous comment, could you provide us with more hints on it?

Do you mean the HTML files needed?

@bsipocz

Hi @bsipocz! PR's opened in the astropy/astropy-sphinx-theme and astropy/astropy repos to attempt to address this Issue. But unless the PR astropy/astropy-sphinx-theme#4 is approved and merged GILES will not show the changes applied.

Think the menubar is ready at PR #8440 now...

@kakirastern

@kakirastern If I understand correctly, #8440 stalled because astropy/astropy-sphinx-theme#4 was merged instead to address this issue, right? Then there's a mention of astropy/astropy-sphinx-theme#9, which refers to astropy/astropy-sphinx-theme#12, but I suppose this one can be closed.

@astrojuanlu

Hi @astrojuanlu Yeah, actually I was about to work with @astrofrog a bit more on the sphinx-theme issue a while (at least a few months) back, but I reckon we both got sidetracked... I still remember this issue except I think Tom is currently hard at work getting a new version of glueviz released. Maybe I will send reminders on Slack again regarding this. I do think this issue can be closed for now, since many things have changed now and the best approach may be sorted out at https://github.com/astropy/astropy-sphinx-theme/. If need be I will open another PR for this in this repo.

I think what remains to be done here is enabling astropy_project_menubar in our conf.py here - I think this can be done with:

  html_theme_options = {
      'logotext1': 'packagename',  # white,  semi-bold
      'logotext2': '',  # orange, light
      'logotext3': ':docs',   # white,  light
      'astropy_project_menubar': True
      }

here: https://github.com/astropy/astropy/blob/master/docs/conf.py#L136

Someone want to take a stab at this? 😄

Ah there was a PR: #8440 - I think there were basically some CSS issues to resolve?

Will need to check the latest RTD build of the docs to ascertain the status...

I think this is done.

Navigation Menu

Repository navigation

Add top menubar from astropy.org #8320

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Add top menubar from astropy.org #8320

Description

Activity

blatted commented on Jan 23, 2019

bsipocz commented on Jan 23, 2019

blatted commented on Jan 24, 2019

bsipocz commented on Jan 24, 2019

blatted commented on Feb 7, 2019

bsipocz commented on Feb 7, 2019

bsipocz commented on Feb 7, 2019

sunn-e commented on Feb 15, 2019

bsipocz commented on Feb 15, 2019

sunn-e commented on Feb 16, 2019

kakirastern commented on Feb 20, 2019

bsipocz commented on Feb 20, 2019

kakirastern commented on Feb 20, 2019

kakirastern commented on Feb 21, 2019

kakirastern commented on Feb 21, 2019

kakirastern commented on Feb 21, 2019

kakirastern commented on Mar 9, 2019

astrojuanlu commented on Oct 4, 2020

kakirastern commented on Oct 4, 2020

astrofrog commented on Oct 4, 2020

astrofrog commented on Oct 4, 2020

kakirastern commented on Oct 4, 2020

pllim commented on Jul 17, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions