sphinx-contrib / sphinxcontrib-versioning

Sphinx extension that allows building versioned docs for self-hosting.
https://sphinxcontrib-versioning.readthedocs.io/en/latest/
MIT License
125 stars 81 forks source link

how to use in the right way? #43

Open mgiaco opened 7 years ago

mgiaco commented 7 years ago

Hi,

I do have a test project with a "doc" folder. In the doc folder I do have a sphinx build under "doc\build\html".

Then I run:

sphinx-versioning build -r master doc doc/build/html

And I get:

=> Gathering info about the remote git repository...
=> Getting list of all remote branches/tags...
=> Found: master v1.0 v1.1 v1.2
=> With docs:
=> No docs found in any remote branch/tag. Nothing to do.
Failure.

So what´s wrong here i read the help but did not find the error.

many thanks

Robpol86 commented 7 years ago

You need to commit the doc folder and push it to origin.

mgiaco commented 7 years ago

Okay but I already did that. Should I also commit the build in that doc folder?

mgiaco commented 7 years ago

Okay now I have some error:

# Sphinx version: 1.6.3
# Python version: 3.6.1 (CPython)
# Docutils version: 0.13.1 release
# Jinja2 version: 2.9.5
# Last messages:

# Loaded extensions:
Traceback (most recent call last):
  File "C:\test\lib\site-packages\sphinx\cmdline.py", line 305, in main
    opts.warningiserror, opts.tags, opts.verbosity, opts.jobs)
  File "C:\test\lib\site-packages\sphinx\application.py", line 234, in __init__
    self._init_builder()
  File "C:\test\lib\site-packages\sphinx\application.py", line 312, in _init_builder
    self.emit('builder-inited')
  File "C:\test\lib\site-packages\sphinx\application.py", line 489, in emit
    return self.events.emit(event, self, *args)
  File "C:\test\lib\site-packages\sphinx\events.py", line 79, in emit
    results.append(callback(*args))
  File "C:\test\lib\site-packages\sphinxcontrib\versioning\sphinx_.py", line 60, in builder_inited
    app.config.html_sidebars['**'] = StandaloneHTMLBuilder.default_sidebars + ['versions.html']
AttributeError: type object 'StandaloneHTMLBuilder' has no attribute 'default_sidebars'

So I use the alabaster theme but I have read that it is supported.

Levi-Armstrong commented 6 years ago

@mgiaco I am getting the same error. Were you able to resolve the issue?

mgiaco commented 6 years ago

@Levi-Armstrong no sorry. I do not search for a solution.

twiecki commented 6 years ago

Getting the same error.

suush commented 6 years ago

This error is due to newer sphinx version(1.6). #46

gryphon2411 commented 4 years ago

Is it going to be fixed?